Struct Field 

pub struct Field {
    pub name: String,
    pub description: Option<String>,
    pub kind: FieldType,
    pub required: bool,
    pub allowed: Vec<String>,
}

One property of an object schema.

Fields

name: String

description: Option<String>

kind: FieldType

required: bool

allowed: Vec<String>

When set, the value must be one of these — a closed set an agent can see.

Implementations

impl Field

pub fn new(name: impl Into<String>, kind: FieldType) -> Self

pub fn string(name: impl Into<String>) -> Self

pub fn number(name: impl Into<String>) -> Self

pub fn integer(name: impl Into<String>) -> Self

pub fn boolean(name: impl Into<String>) -> Self

pub fn array_of(name: impl Into<String>, item: FieldType) -> Self

pub fn object(name: impl Into<String>, schema: Schema) -> Self

pub fn any(name: impl Into<String>) -> Self

pub fn describe(self, description: impl Into<String>) -> Self

The sentence the calling model reads to decide what to put here.

pub fn optional(self) -> Self

pub fn one_of<I, S>(self, values: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Restrict to a fixed set of string values.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl PartialEq for Field

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Field