WIP

FerretDB · w84thesun · May 23, 2023 · May 15, 2023 · May 15, 2023 · May 15, 2023
commit fa3aa0442a3cf82283bed7ebe959cc9a3fcf7471
@@ -28,7 +28,7 @@ import (
 
 // GetRequiredParam returns doc's value for key.
 //
-// Returned errors:
+// It returns command errors with the following codes:
 //   - ErrBadValue if the document value is missing;
 //   - ErrBadValue if the document value is not of the expected type.
 func GetRequiredParam[T types.Type](doc *types.Document, key string) (T, error) {
@@ -51,7 +51,7 @@ func GetRequiredParam[T types.Type](doc *types.Document, key string) (T, error)
 
 // GetOptionalParam returns doc's value for key or default value for missing parameter.
 //
-// ErrTypeMismatch returned if the document value is not of the expected type.
+// It returns command error with the ErrTypeMismatch code if the document value is not of the expected type.
 func GetOptionalParam[T types.Type](doc *types.Document, key string, defaultValue T) (T, error) {
 	v, _ := doc.Get(key)
 	if v == nil {
@@ -74,7 +74,7 @@ func GetOptionalParam[T types.Type](doc *types.Document, key string, defaultValu
 
 // GetOptionalNullParam returns doc's value for key, default value for missing parameter or null.
 //
-// ErrTypeMismatch returned if the document value is not of the expected type.
+// It returns command error with ErrTypeMismatch code if the document value is not of the expected type.
 func GetOptionalNullParam[T types.Type](doc *types.Document, key string, defaultValue T) (T, error) {
 	v, err := GetOptionalParam(doc, key, defaultValue)
 	if err != nil {
@@ -96,7 +96,7 @@ func GetOptionalNullParam[T types.Type](doc *types.Document, key string, default
 //	  return commonerrors.NewCommandErrorMsg(commonerrors.ErrBadValue, "expected document")
 //	}
 //
-// ErrBadValue returned if the value is not of the expected type.
+// It returns command error with ErrBadValue code if the value is not of the expected type.
 func AssertType[T types.Type](value any) (T, error) {
 	res, ok := value.(T)
 	if !ok {
@@ -109,7 +109,7 @@ func AssertType[T types.Type](value any) (T, error) {
 
 // GetLimitStageParam returns $limit stage argument from the provided value.
 //
-// Returned errors:
+// It returns command errors with the following codes:
 //   - ErrStageLimitInvalidArg if the value type is not [int, long, double];
 //   - ErrStageLimitInvalidArg if the value is not a whole number or is NaN;
 //   - ErrStageLimitInvalidArg if the value is not in the range of int64;
@@ -162,7 +162,7 @@ func GetLimitStageParam(value any) (int64, error) {
 
 // GetSkipStageParam returns $skip stage argument from the provided value.
 //
-// Returned errors:
+// It returns command errors with the following codes:
 //   - ErrStageSkipBadValue if the value type is not [int, long, double];
 //   - ErrStageSkipBadValue if the value is not a whole number or is NaN;
 //   - ErrStageSkipBadValue if the value is not in the range of int64;
@@ -205,7 +205,7 @@ func GetSkipStageParam(value any) (int64, error) {
 // getBinaryMaskParam matches value type, returning bit mask and error if match failed.
 // Possible values are: position array ([1,3,5] == 010101), whole number value and types.Binary value.
 //
-// Returned errors:
+// It returns command errors with the following codes:
 //   - ErrBadValue if positional argument is not a whole number of type [int, long, double];
 //   - ErrBadValue if positional argument is negative;
 //   - ErrFailedToParse if bitmask argument is not a whole number or negative;

@@ -49,7 +49,7 @@ import (
 // If the field could have different types (e.g. `*types.Document` and `*types.Array`) then
 // the field must be of type `any`.
 //
-// Errors list:
+// It returns command errors with the following codes:
 //   - `ErrFailedToParse` when provided field is not present in passed structure;
 //   - `ErrFailedToParse` when provided field must be 0 or 1, but it is not;
 //   - `ErrNotImplemented` when support for provided field is not implemented yet;

@@ -74,7 +74,7 @@ func GetWholeNumberParam(value any) (int64, error) {
 //
 // # If the value is valid, it returns its int64 representation
 //
-// Command errors:
+// It returns command errors with the following codes:
 //   - ErrTypeMismatch if the value is not of types [int, long, double, null];
 //   - ErrValueNegative if the value is negative;
 func getWholeParamStrict(command string, param string, value any) (int64, error) {
@@ -131,7 +131,7 @@ func getWholeParamStrict(command string, param string, value any) (int64, error)
 
 // getOptionalPositiveNumber returns doc's value for key.
 //
-// Return errors:
+// It returns command errors with the following codes:
 //   - ErrBadValue if value is not a number;
 //   - ErrBadValue if value is not of types [int, long];
 //   - ErrBadValue if value exceeds int32 range;
@@ -187,7 +187,7 @@ func getOptionalPositiveNumber(key string, value any) (int64, error) {
 // GetBoolOptionalParam returns bool value of v.
 // Non-zero double, long, and int values return true.
 // Zero values for those types, as well as nulls and missing fields, return false.
-// Other types return ErrTypeMismatch command error.
+// Other types return command error with ErrTypeMismatch code.
 func GetBoolOptionalParam(key string, v any) (bool, error) {
 	switch v := v.(type) {
 	case float64: