Struct StringMandatoryRules 

pub struct StringMandatoryRules {
    pub is_mandatory: bool,
}

A struct representing rules for mandatory string fields.

This struct is designed to hold the configuration for whether a particular string field is mandatory or optional. It provides a simple boolean flag indicating the “mandatory” nature of the string.

Fields

• is_mandatory
  • A boolean field that determines whether the string is mandatory.
  • When set to true, the associated string must be provided.
  • When set to false, the associated string is optional.

Traits

• The Default trait is implemented for this struct, allowing you to create a default instance where is_mandatory is set to false.

Fields

is_mandatory: bool

Implementations

impl StringMandatoryRules

pub fn check( &self, messages: &mut ValidateErrorCollector, subject: &StringValidator<'_>, )

Validates a string based on the provided StringValidator and collects validation errors.

Parameters

• messages: A mutable reference to a ValidateErrorCollector that accumulates validation errors encountered during the check.
• subject: A reference to a StringValidator representing the string to be validated.

Behavior

• If the self.is_mandatory field is true and the subject is empty, an error message with the text "Cannot be empty" is pushed into the messages collector along with a locale identifier (StringMandatoryLocale).

Example

use cjtoolkit_structured_validator::common::locale::ValidateErrorCollector;
use cjtoolkit_structured_validator::common::string_validator::StrValidationExtension;
use cjtoolkit_structured_validator::base::string_rules::StringMandatoryRules;
let mut messages = ValidateErrorCollector::new();
let validator = StringMandatoryRules { is_mandatory: true };
let subject = "".as_string_validator();

validator.check(&mut messages, &subject);

assert_eq!(messages.len(), 1); // If the subject is empty and is_mandatory is true, an error will be collected.

Trait Implementations

impl Default for StringMandatoryRules

fn default() -> StringMandatoryRules

Returns the “default value” for a type.

impl Into<StringMandatoryRules> for &EmailRules

Available on crate feature email only.

fn into(self) -> StringMandatoryRules

Converts this type into the (usually inferred) input type.

impl Into<StringMandatoryRules> for &UrlRules

Available on crate feature url only.

fn into(self) -> StringMandatoryRules

Converts this type into the (usually inferred) input type.