BytesRules

Struct BytesRules 

Source
pub struct BytesRules {
    pub const: Option<Bytes>,
    pub len: Option<u64>,
    pub min_len: Option<u64>,
    pub max_len: Option<u64>,
    pub pattern: Option<String>,
    pub prefix: Option<Bytes>,
    pub suffix: Option<Bytes>,
    pub contains: Option<Bytes>,
    pub in: Vec<Bytes>,
    pub not_in: Vec<Bytes>,
    pub example: Vec<Bytes>,
    pub well_known: Option<WellKnown>,
}
Available on crate feature protovalidate only.
Expand description

BytesRules describe the rules applied to bytes values. These rules may also be applied to the google.protobuf.BytesValue Well-Known-Type.

Fields§

§const: Option<Bytes>

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"\];
}
§len: Option<u64>

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\];
}
§min_len: Option<u64>

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\];
}
§max_len: Option<u64>

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\];
}
§pattern: Option<String>

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\]+$"];
}
§prefix: Option<Bytes>

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"\];
}
§suffix: Option<Bytes>

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"\];
}
§contains: Option<Bytes>

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"\];
}
§in: Vec<Bytes>

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"}\];
}
§not_in: Vec<Bytes>

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"}\];
}
§example: Vec<Bytes>

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"
   ];
}
§well_known: Option<WellKnown>

WellKnown rules provide advanced rules against common byte patterns

Implementations§

Source§

impl BytesRules

Source

pub fn length_rules(&self) -> Result<LengthRules, String>

Available on crate feature protocheck only.
Source§

impl BytesRules

Source

pub fn substring_rules(&self) -> SubstringRules

Available on crate feature protocheck only.
Source§

impl BytesRules

Source

pub fn containing_rules( &self, field_full_name: &str, ) -> Result<ContainingRules, Vec<LitByteStr>>

Available on crate feature protocheck only.
Source§

impl BytesRules

Source

pub fn const_rule(&self) -> Option<ConstRule<LitByteStr>>

Available on crate feature protocheck only.
Source§

impl BytesRules

Source

pub fn const(&self) -> &[u8]

Returns the value of const, or the default value if const is unset.

Source

pub fn min_len(&self) -> u64

Returns the value of min_len, or the default value if min_len is unset.

Source

pub fn max_len(&self) -> u64

Returns the value of max_len, or the default value if max_len is unset.

Source

pub fn pattern(&self) -> &str

Returns the value of pattern, or the default value if pattern is unset.

Source

pub fn prefix(&self) -> &[u8]

Returns the value of prefix, or the default value if prefix is unset.

Source

pub fn suffix(&self) -> &[u8]

Returns the value of suffix, or the default value if suffix is unset.

Source

pub fn contains(&self) -> &[u8]

Returns the value of contains, or the default value if contains is unset.

Source

pub fn len(&self) -> u64

Returns the value of len, or the default value if len is unset.

Trait Implementations§

Source§

impl Clone for BytesRules

Source§

fn clone(&self) -> BytesRules

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BytesRules

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BytesRules

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Hash for BytesRules

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for BytesRules

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for BytesRules

Source§

fn eq(&self, other: &BytesRules) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for BytesRules

Source§

impl StructuralPartialEq for BytesRules

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyExt for T
where T: Any + ?Sized,

Source§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
Source§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
Source§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
Source§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
Source§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
Source§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
Source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

Source§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

Source§

fn coerce_box_to(self: Box<X>) -> Box<T>

Source§

fn coerce_ref_to(&self) -> &T

Source§

fn coerce_mut_to(&mut self) -> &mut T

Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.