Interface BytesRules

Returns a safe value for JSON logs.

Preserves protobuf fields that this SDK version does not recognize.

Contains the fully qualified protobuf type name.

const requires the field value to exactly match the specified bytes value. If the field value doesn't match, an error message is generated.

message MyBytes {
  // value must be "\x01\x02\x03\x04"
  bytes value = 1 [(buf.validate.field).bytes.const = "\x01\x02\x03\x04"];
}
Copy

contains requires the field value to have the specified bytes anywhere in the string. If the field value doesn't meet the requirement, an error message is generated.

message MyBytes {
  // value does not contain \x02\x03
  optional bytes value = 1 [(buf.validate.field).bytes.contains = "\x02\x03"];
}
Copy

example specifies values that the field may have. These values SHOULD conform to other rules. example values will not impact validation but may be used as helpful guidance on how to populate the given field.

message MyBytes {
  bytes value = 1 [
    (buf.validate.field).bytes.example = "\x01\x02",
    (buf.validate.field).bytes.example = "\x02\x03"
  ];
}
Copy

in requires the field value to be equal to one of the specified values. If the field value doesn't match any of the specified values, an error message is generated.

message MyBytes {
  // value must in ["\x01\x02", "\x02\x03", "\x03\x04"]
  optional bytes value = 1 [(buf.validate.field).bytes.in = {"\x01\x02", "\x02\x03", "\x03\x04"}];
}
Copy

len requires the field value to have the specified length in bytes. If the field value doesn't match, an error message is generated.

message MyBytes {
  // value length must be 4 bytes.
  optional bytes value = 1 [(buf.validate.field).bytes.len = 4];
}
Copy

max_len requires the field value to have at most the specified maximum length in bytes. If the field value exceeds the requirement, an error message is generated.

message MyBytes {
  // value must be at most 6 bytes.
  optional bytes value = 1 [(buf.validate.field).bytes.max_len = 6];
}
Copy

min_len requires the field value to have at least the specified minimum length in bytes. If the field value doesn't meet the requirement, an error message is generated.

message MyBytes {
  // value length must be at least 2 bytes.
  optional bytes value = 1 [(buf.validate.field).bytes.min_len = 2];
}
Copy

not_in requires the field value to be not equal to any of the specified values. If the field value matches any of the specified values, an error message is generated.

message MyBytes {
  // value must not in ["\x01\x02", "\x02\x03", "\x03\x04"]
  optional bytes value = 1 [(buf.validate.field).bytes.not_in = {"\x01\x02", "\x02\x03", "\x03\x04"}];
}
Copy

pattern requires the field value to match the specified regular expression (RE2 syntax). The value of the field must be valid UTF-8 or validation will fail with a runtime error. If the field value doesn't match the pattern, an error message is generated.

message MyBytes {
  // value must match regex pattern "^[a-zA-Z0-9]+$".
  optional bytes value = 1 [(buf.validate.field).bytes.pattern = "^[a-zA-Z0-9]+$"];
}
Copy

prefix requires the field value to have the specified bytes at the beginning of the string. If the field value doesn't meet the requirement, an error message is generated.

message MyBytes {
  // value does not have prefix \x01\x02
  optional bytes value = 1 [(buf.validate.field).bytes.prefix = "\x01\x02"];
}
Copy

suffix requires the field value to have the specified bytes at the end of the string. If the field value doesn't meet the requirement, an error message is generated.

message MyBytes {
  // value does not have suffix \x03\x04
  optional bytes value = 1 [(buf.validate.field).bytes.suffix = "\x03\x04"];
}
Copy

WellKnown rules provide advanced rules against common byte patterns