Struct FieldSchema 

pub struct FieldSchema { /* private fields */ }

Immutable schema for one catalog-owned context field.

Schemas define the external name, value shape, visibility, and text bound. Their fields and constructor are private so callers can inspect catalog policy but cannot create or alter it.

use rocketmq_error::{ContextVisibility, FieldSchema, FieldValueKind};

let _ = FieldSchema {
    name: "external_name",
    visibility: ContextVisibility::Public,
    value_kind: FieldValueKind::Text,
    text_byte_limit: Some(64),
};

use rocketmq_error::{ContextVisibility, FieldSchema, FieldValueKind};

let _ = FieldSchema::try_new(
    "external_name",
    ContextVisibility::Public,
    FieldValueKind::Text,
    Some(64),
);

Implementations

impl FieldSchema

pub const fn name(self) -> &'static str

Returns the lower-snake-case external field name.

pub const fn visibility(self) -> ContextVisibility

Returns the visibility policy for this field.

pub const fn value_kind(self) -> FieldValueKind

Returns the field’s closed value shape.

pub const fn text_byte_limit(self) -> Option<usize>

Returns the maximum retained text size in bytes.

Non-text fields always return None.

Trait Implementations

impl Clone for FieldSchema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FieldSchema

impl Debug for FieldSchema

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

Formats the value using the given formatter.

impl Eq for FieldSchema

impl Hash for FieldSchema

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FieldSchema

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FieldSchema

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FieldSchema

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for FieldSchema