Struct ZString 

pub struct ZString { /* private fields */ }

Schema for string validation. Created via vld::string().

Example

use vld::prelude::*;

let schema = vld::string().min(3).max(20).email();

Implementations

impl ZString

pub fn email(self) -> ZString

Must be a valid email address.

pub fn email_msg(self, msg: impl Into<String>) -> ZString

Must be a valid email address.

With a custom error message.

pub fn url(self) -> ZString

Must be a valid URL (http/https).

pub fn url_msg(self, msg: impl Into<String>) -> ZString

Must be a valid URL (http/https).

With a custom error message.

pub fn uuid(self) -> ZString

Must be a valid UUID.

pub fn uuid_msg(self, msg: impl Into<String>) -> ZString

Must be a valid UUID.

With a custom error message.

pub fn ip(self) -> ZString

Must be a valid IP address (IPv4 or IPv6).

pub fn ip_msg(self, msg: impl Into<String>) -> ZString

Must be a valid IP address (IPv4 or IPv6).

With a custom error message.

pub fn slug(self) -> ZString

Must be a URL-friendly slug ([a-z0-9-]).

pub fn slug_msg(self, msg: impl Into<String>) -> ZString

Must be a URL-friendly slug ([a-z0-9-]).

With a custom error message.

pub fn color(self) -> ZString

Must be a color (#RRGGBB, #RRGGBBAA, rgb(...), hsl(...)).

pub fn color_msg(self, msg: impl Into<String>) -> ZString

Must be a color (#RRGGBB, #RRGGBBAA, rgb(...), hsl(...)).

With a custom error message.

pub fn currency_code(self) -> ZString

Must be a currency code (ISO-4217-like uppercase 3 letters).

pub fn currency_code_msg(self, msg: impl Into<String>) -> ZString

Must be a currency code (ISO-4217-like uppercase 3 letters).

With a custom error message.

pub fn country_code(self) -> ZString

Must be a country code (ISO-3166 alpha-2).

pub fn country_code_msg(self, msg: impl Into<String>) -> ZString

Must be a country code (ISO-3166 alpha-2).

With a custom error message.

pub fn locale(self) -> ZString

Must be a locale (ll or ll-RR, example: en, en-US).

pub fn locale_msg(self, msg: impl Into<String>) -> ZString

Must be a locale (ll or ll-RR, example: en, en-US).

With a custom error message.

pub fn cron(self) -> ZString

Must be a cron expression (5 or 6 fields).

pub fn cron_msg(self, msg: impl Into<String>) -> ZString

Must be a cron expression (5 or 6 fields).

With a custom error message.

pub fn ipv4(self) -> ZString

Must be a valid IPv4 address.

pub fn ipv4_msg(self, msg: impl Into<String>) -> ZString

Must be a valid IPv4 address.

With a custom error message.

pub fn ipv6(self) -> ZString

Must be a valid IPv6 address (IPv4-mapped forms included).

pub fn ipv6_msg(self, msg: impl Into<String>) -> ZString

Must be a valid IPv6 address (IPv4-mapped forms included).

With a custom error message.

pub fn cidr(self) -> ZString

Must be a valid CIDR block (IPv4/IPv6 with a decimal prefix).

pub fn cidr_msg(self, msg: impl Into<String>) -> ZString

Must be a valid CIDR block (IPv4/IPv6 with a decimal prefix).

With a custom error message.

pub fn mac(self) -> ZString

Must be a valid MAC address (xx:xx:xx:xx:xx:xx).

pub fn mac_msg(self, msg: impl Into<String>) -> ZString

Must be a valid MAC address (xx:xx:xx:xx:xx:xx).

With a custom error message.

pub fn hex(self) -> ZString

Must contain only hexadecimal characters.

pub fn hex_msg(self, msg: impl Into<String>) -> ZString

Must contain only hexadecimal characters.

With a custom error message.

pub fn credit_card(self) -> ZString

Must be a valid credit card number: digits with optional spaces/dashes, 12-19 digits, Luhn check.

pub fn credit_card_msg(self, msg: impl Into<String>) -> ZString

Must be a valid credit card number: digits with optional spaces/dashes, 12-19 digits, Luhn check.

With a custom error message.

pub fn phone(self) -> ZString

Must be an international phone number: leading +, 8-15 digits, optional spaces, dashes and parentheses.

pub fn phone_msg(self, msg: impl Into<String>) -> ZString

Must be an international phone number: leading +, 8-15 digits, optional spaces, dashes and parentheses.

With a custom error message.

pub fn semver(self) -> ZString

Must be a semantic version (MAJOR.MINOR.PATCH, optional v prefix).

pub fn semver_msg(self, msg: impl Into<String>) -> ZString

Must be a semantic version (MAJOR.MINOR.PATCH, optional v prefix).

With a custom error message.

pub fn jwt(self) -> ZString

Must be a JWT-like token (header.payload.signature, base64url parts).

pub fn jwt_msg(self, msg: impl Into<String>) -> ZString

Must be a JWT-like token (header.payload.signature, base64url parts).

With a custom error message.

pub fn ascii(self) -> ZString

Must contain only ASCII characters.

pub fn ascii_msg(self, msg: impl Into<String>) -> ZString

Must contain only ASCII characters.

With a custom error message.

pub fn alpha(self) -> ZString

Must contain only alphabetic ASCII characters.

pub fn alpha_msg(self, msg: impl Into<String>) -> ZString

Must contain only alphabetic ASCII characters.

With a custom error message.

pub fn alphanumeric(self) -> ZString

Must contain only ASCII alphanumeric characters.

pub fn alphanumeric_msg(self, msg: impl Into<String>) -> ZString

Must contain only ASCII alphanumeric characters.

With a custom error message.

pub fn lowercase(self) -> ZString

Must already be lowercase.

pub fn lowercase_msg(self, msg: impl Into<String>) -> ZString

Must already be lowercase.

With a custom error message.

pub fn uppercase(self) -> ZString

Must already be uppercase.

pub fn uppercase_msg(self, msg: impl Into<String>) -> ZString

Must already be uppercase.

With a custom error message.

pub fn base64(self) -> ZString

Must be a valid (padded) Base64 string.

pub fn base64_msg(self, msg: impl Into<String>) -> ZString

Must be a valid (padded) Base64 string.

With a custom error message.

pub fn base64url(self) -> ZString

Must be a valid Base64URL string (-/_ alphabet, padding optional).

pub fn base64url_msg(self, msg: impl Into<String>) -> ZString

Must be a valid Base64URL string (-/_ alphabet, padding optional).

With a custom error message.

pub fn json(self) -> ZString

Must be a string containing one valid JSON document.

pub fn json_msg(self, msg: impl Into<String>) -> ZString

Must be a string containing one valid JSON document.

With a custom error message.

pub fn iso_date(self) -> ZString

Must be a valid ISO 8601 calendar date (YYYY-MM-DD, real day of month).

pub fn iso_date_msg(self, msg: impl Into<String>) -> ZString

Must be a valid ISO 8601 calendar date (YYYY-MM-DD, real day of month).

With a custom error message.

pub fn iso_datetime(self) -> ZString

Must be a valid ISO 8601 datetime: YYYY-MM-DDTHH:MM:SS[.frac] (seconds required, T/t) with optional Z/z / ±HH:MM — the same grammar as vld::chrono::datetime() & co.

pub fn iso_datetime_msg(self, msg: impl Into<String>) -> ZString

Must be a valid ISO 8601 datetime: YYYY-MM-DDTHH:MM:SS[.frac] (seconds required, T/t) with optional Z/z / ±HH:MM — the same grammar as vld::chrono::datetime() & co.

With a custom error message.

pub fn iso_time(self) -> ZString

Must be a valid ISO 8601 time (HH:MM[:SS[.frac]]).

pub fn iso_time_msg(self, msg: impl Into<String>) -> ZString

Must be a valid ISO 8601 time (HH:MM[:SS[.frac]]).

With a custom error message.

pub fn hostname(self) -> ZString

Must be a valid hostname.

pub fn hostname_msg(self, msg: impl Into<String>) -> ZString

Must be a valid hostname.

With a custom error message.

pub fn cuid2(self) -> ZString

Must be a valid CUID2 (2-32 lowercase alphanumerics, starting with a letter).

pub fn cuid2_msg(self, msg: impl Into<String>) -> ZString

Must be a valid CUID2 (2-32 lowercase alphanumerics, starting with a letter).

With a custom error message.

pub fn ulid(self) -> ZString

Must be a valid ULID (26-char Crockford Base32).

pub fn ulid_msg(self, msg: impl Into<String>) -> ZString

Must be a valid ULID (26-char Crockford Base32).

With a custom error message.

pub fn nanoid(self) -> ZString

Must be a valid Nano ID (alphanumeric + _ + -).

pub fn nanoid_msg(self, msg: impl Into<String>) -> ZString

Must be a valid Nano ID (alphanumeric + _ + -).

With a custom error message.

pub fn emoji(self) -> ZString

Must be non-empty and consist only of emoji.

pub fn emoji_msg(self, msg: impl Into<String>) -> ZString

Must be non-empty and consist only of emoji.

With a custom error message.

impl ZString

pub fn new() -> ZString

Create the schema (the same as its vld:: constructor function).

pub fn type_error(self, msg: impl Into<String>) -> ZString

Set a custom error message for type mismatch (when the input is not a string).

Example

use vld::prelude::*;
let schema = vld::string().type_error("Must be text!");
let err = schema.parse("42").unwrap_err();
assert!(err.issues[0].message.contains("Must be text!"));

pub fn with_messages<F>(self, f: F) -> ZString

where F: Fn(&str) -> Option<String> + Send + Sync + 'static,

Override error messages in bulk by check key.

The closure receives the check key (e.g. "too_small", "invalid_email") and should return Some(new_message) to replace, or None to keep the original.

Keys: "too_small", "too_big", "invalid_length", "non_empty", "invalid_regex", "invalid_starts_with", "invalid_ends_with", "invalid_contains", and "invalid_<format>" for every format check ("invalid_email", "invalid_url", "invalid_uuid", "invalid_ip", "invalid_currency", "invalid_phone_e164", …).

The closure is consulted when an issue is built, so it covers checks added before and after this call; a per-check message (*_msg(...)) takes precedence over it. A later call replaces it.

Example

use vld::prelude::*;
let schema = vld::string().min(3).email()
    .with_messages(|key| match key {
        "too_small" => Some("Too short!".into()),
        "invalid_email" => Some("Bad email!".into()),
        _ => None,
    });

pub fn min(self, len: usize) -> ZString

Minimum string length in characters (inclusive).

pub fn min_msg(self, len: usize, msg: impl Into<String>) -> ZString

Minimum string length with custom message.

pub fn max(self, len: usize) -> ZString

Maximum string length in characters (inclusive).

pub fn max_msg(self, len: usize, msg: impl Into<String>) -> ZString

Maximum string length with custom message.

pub fn len(self, len: usize) -> ZString

Exact string length in characters.

pub fn len_msg(self, len: usize, msg: impl Into<String>) -> ZString

Exact string length with custom message.

pub fn rule(self, rule: impl Rule<str>) -> ZString

Check with a reusable Rule on the string (keeps the ZString builder; see vld::rules).

pub fn rule_msg(self, rule: impl Rule<str>, msg: impl Into<String>) -> ZString

rule with a custom message.

pub fn starts_with(self, prefix: impl Into<String>) -> ZString

Must start with the given prefix.

pub fn starts_with_msg( self, prefix: impl Into<String>, msg: impl Into<String>, ) -> ZString

Must start with the given prefix, with custom message.

pub fn ends_with(self, suffix: impl Into<String>) -> ZString

Must end with the given suffix.

pub fn ends_with_msg( self, suffix: impl Into<String>, msg: impl Into<String>, ) -> ZString

Must end with the given suffix, with custom message.

pub fn contains(self, sub: impl Into<String>) -> ZString

Must contain the given substring.

pub fn contains_msg( self, sub: impl Into<String>, msg: impl Into<String>, ) -> ZString

Must contain the given substring, with custom message.

pub fn non_empty(self) -> ZString

Must not be empty.

pub fn non_empty_msg(self, msg: impl Into<String>) -> ZString

Must not be empty, with custom message.

pub fn trim(self) -> ZString

Trim whitespace before validation.

pub fn to_lowercase(self) -> ZString

Convert to lowercase before validation.

pub fn to_uppercase(self) -> ZString

Convert to uppercase before validation.

pub fn coerce(self) -> ZString

Coerce non-string values (numbers, booleans) to string.

Trait Implementations

impl Clone for ZString

fn clone(&self) -> ZString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ZString

fn default() -> ZString

Returns the “default value” for a type.

impl VldSchema for ZString

type Output = String

The Rust type produced by this schema after successful parsing.

fn parse_value(&self, value: &Value) -> Result<String, VldError>

Parse and validate a serde_json::Value.

fn parse_missing(&self) -> Result<Self::Output, VldError>

Parse an object field whose key is absent.

fn parse<I>(&self, input: &I) -> Result<Self::Output, VldError>

where I: VldInput + ?Sized,

Parse from any supported input (JSON string, file path, serde_json::Value, etc.)

fn validate<T>(&self, value: &T) -> Result<Self::Output, VldError>

where T: Serialize,

Validate an existing Rust value against this schema.

fn is_valid<T>(&self, value: &T) -> bool

where T: Serialize,

Check if an existing Rust value passes this schema’s validation.

fn optional(self) -> ZOptional<Self>

Make this field optional. Missing or null values become None.

fn nullable(self) -> ZNullable<Self>

Allow null values. Null becomes None.

fn with_default(self, value: Self::Output) -> ZDefault<Self>

where Self::Output: Clone,

Provide a default value when the field is missing or null.

fn refine<F>(self, check: F, message: &str) -> ZRefine<Self, F>

where F: Fn(&Self::Output) -> bool,

Add a custom refinement check without changing the output type.

fn rule<R>(self, rule: R) -> ZRule<Self, R>

where Self: Sized, R: Rule<Self::Output>,

Check the output with a reusable Rule (output type unchanged).

fn rule_msg<R>(self, rule: R, msg: impl Into<String>) -> ZRule<Self, R>

where Self: Sized, R: Rule<Self::Output>,

rule with a custom error message.

fn transform<F, U>(self, f: F) -> ZTransform<Self, F, U>

where F: Fn(Self::Output) -> U,

Transform the output value after successful parsing.

fn nullish(self) -> ZNullish<Self>

Make this field nullish (both optional and nullable).

fn catch(self, fallback: Self::Output) -> ZCatch<Self>

where Self::Output: Clone,

Return a fallback value on ANY validation error.

fn pipe<S>(self, next: S) -> ZPipe<Self, S>

where S: VldSchema, Self::Output: Serialize,

Chain this schema’s output into another schema.

fn describe(self, description: &str) -> ZDescribe<Self>

Attach a human-readable description/label to this schema.

fn super_refine<F>(self, check: F) -> ZSuperRefine<Self, F>

where F: Fn(&Self::Output, &mut VldError),

Add a custom refinement that can produce multiple errors.

fn or<B>(self, other: B) -> ZUnion2<Self, B>

where B: VldSchema,

Create a union: this schema or another. Returns Either<Self::Output, B::Output>.

fn and<B>(self, other: B) -> ZIntersection<Self, B>

where B: VldSchema,

Create an intersection: input must satisfy both schemas.

fn message(self, msg: impl Into<String>) -> ZMessage<Self>

Override the error message for this schema.