Struct oapi::OApiSchemaString

pub struct OApiSchemaString { /* fields omitted */ }

An string in a schema

Implementations

impl OApiSchemaString

pub fn pattern(&self) -> &Option<String>

A regex this string should support

pub fn min_length(&self) -> &Option<u64>

The lower bound for the string length

pub fn max_length(&self) -> &Option<u64>

The upper bound for the string length

pub fn format(&self) -> &Option<OApiStringFormat>

The format to use for the string

pub fn enum_(&self) -> &Option<Vec<String>>

An enum of valid values

pub fn nullable(&self) -> &Option<OperatorSelector<bool>>

Mark the string as nullable

pub fn read_only(&self) -> &Option<OperatorSelector<bool>>

Mark the string as read-only

pub fn write_only(&self) -> &Option<OperatorSelector<bool>>

Mark the string as write-only

pub fn example(&self) -> &Option<OperatorSelector<Value>>

An example for the string

pub fn deprecated(&self) -> &Option<OperatorSelector<bool>>

Mark this string as deprecated

pub fn discriminator(
    &self
) -> &Option<OperatorSelector<OApiSchemaDiscriminator>>

A discriminator for this string

pub fn external_docs(
    &self
) -> &Option<OperatorSelector<OApiExternalDocumentation>>

External documentation for this string, if any

Trait Implementations

impl Clone for OApiSchemaString

fn clone(&self) -> OApiSchemaString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OApiSchemaString

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

Formats the value using the given formatter.

impl Default for OApiSchemaString

fn default() -> OApiSchemaString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OApiSchemaString where
    OApiSchemaString: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl OApiCheckTrait for OApiSchemaString

fn oapi_check(
    &self,
    root: &SparseRoot<OApiDocument>,
    bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>

Check the current object, if any checks are to be performed, then checks its inner attributes

fn oapi_check_inner(
    &self,
    root: &SparseRoot<OApiDocument>,
    bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>

Check every inner attributes of the object

impl OApiExtensionExtractor for OApiSchemaString

fn oapi_raw_ext(&self) -> &HashMap<String, Value>

Return a map of value of the additionnal keys for that object

fn oapi_extract_ext<S>(
    &self,
    root: &SparseRoot<OApiDocument>,
    key: &str
) -> Result<S, OApiError> where
    S: DeserializeOwned + SparsableTrait + Serialize + OApiCheckTrait, 

Try to deserialize to the type S the object at key, providing the root of the document for any SparsePointer dereferencing

impl PartialEq<OApiSchemaString> for OApiSchemaString

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for OApiSchemaString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sparsable for OApiSchemaString

fn sparse_init(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Initialize recusively a Sparsable pointer

pub fn sparse_updt(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Update recusively a Sparsable pointer

pub fn check_depth(&self, depth: u32) -> Result<(), SparseError>

Check if the current depth isn’t too much. This is the cyclic pointer protection mechanism

impl StructuralPartialEq for OApiSchemaString