Skip to main content

ObjectBuilder

reinhardt

Struct ObjectBuilder 

Source 
pub struct ObjectBuilder { /* private fields */ }
Available on crate feature openapi and non-WebAssembly only.
Expand description

Builder for Object with chainable configuration methods to create a new Object.

Implementations§

Source§

impl ObjectBuilder

Source

pub fn new() -> ObjectBuilder

Available on crate feature rest only.

Constructs a new ObjectBuilder.

Source

pub fn build(self) -> Object

Available on crate feature rest only.

Constructs a new Object taking all fields values from this object.

Source§

impl ObjectBuilder

Source

pub fn schema_type<T>(self, schema_type: T) -> ObjectBuilder
where T: Into<SchemaType>,

Available on crate feature rest only.

Add or change type of the object e.g. to change type to string use value SchemaType::Type(Type::String).

Source

pub fn format(self, format: Option<SchemaFormat>) -> ObjectBuilder

Available on crate feature rest only.

Add or change additional format for detailing the schema type.

Source

pub fn property<S, I>(self, property_name: S, component: I) -> ObjectBuilder
where S: Into<String>, I: Into<RefOr<Schema>>,

Available on crate feature rest only.

Add new property to the Object.

Method accepts property name and property component as an arguments.

Source

pub fn additional_properties<I>( self, additional_properties: Option<I>, ) -> ObjectBuilder
where I: Into<AdditionalProperties<Schema>>,

Available on crate feature rest only.

Add additional Schema for non specified fields (Useful for typed maps).

Source

pub fn property_names<S>(self, property_name: Option<S>) -> ObjectBuilder
where S: Into<Schema>,

Available on crate feature rest only.

Add additional Schema to describe property names of an object such as a map. See more details https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-01#name-propertynames

Source

pub fn required<I>(self, required_field: I) -> ObjectBuilder
where I: Into<String>,

Available on crate feature rest only.

Add field to the required fields of Object.

Source

pub fn title<I>(self, title: Option<I>) -> ObjectBuilder
where I: Into<String>,

Available on crate feature rest only.

Add or change the title of the Object.

Source

pub fn description<I>(self, description: Option<I>) -> ObjectBuilder
where I: Into<String>,

Available on crate feature rest only.

Add or change description of the property. Markdown syntax is supported.

Source

pub fn default(self, default: Option<Value>) -> ObjectBuilder

Available on crate feature rest only.

Add or change default value for the object which is provided when user has not provided the input in Swagger UI.

Source

pub fn deprecated(self, deprecated: Option<Deprecated>) -> ObjectBuilder

Available on crate feature rest only.

Add or change deprecated status for Object.

Source

pub fn enum_values<I, E>(self, enum_values: Option<I>) -> ObjectBuilder
where I: IntoIterator<Item = E>, E: Into<Value>,

Available on crate feature rest only.

Add or change enum property variants.

Source

pub fn example(self, example: Option<Value>) -> ObjectBuilder

👎Deprecated:

Since OpenAPI 3.1 prefer using examples

Available on crate feature rest only.

Add or change example shown in UI of the value for richer documentation.

Deprecated since 3.0.x. Prefer Object::examples instead

Source

pub fn examples<I, V>(self, examples: I) -> ObjectBuilder
where I: IntoIterator<Item = V>, V: Into<Value>,

Available on crate feature rest only.

Add or change examples shown in UI of the value for richer documentation.

Source

pub fn write_only(self, write_only: Option<bool>) -> ObjectBuilder

Available on crate feature rest only.

Add or change write only flag for Object.

Source

pub fn read_only(self, read_only: Option<bool>) -> ObjectBuilder

Available on crate feature rest only.

Add or change read only flag for Object.

Source

pub fn xml(self, xml: Option<Xml>) -> ObjectBuilder

Available on crate feature rest only.

Add or change additional Xml formatting of the Object.

Source

pub fn multiple_of<N>(self, multiple_of: Option<N>) -> ObjectBuilder
where N: Into<Number>,

Available on crate feature rest only.

Set or change multiple_of validation flag for number and integer type values.

Source

pub fn maximum<N>(self, maximum: Option<N>) -> ObjectBuilder
where N: Into<Number>,

Available on crate feature rest only.

Set or change inclusive maximum value for number and integer values.

Source

pub fn minimum<N>(self, minimum: Option<N>) -> ObjectBuilder
where N: Into<Number>,

Available on crate feature rest only.

Set or change inclusive minimum value for number and integer values.

Source

pub fn exclusive_maximum<N>(self, exclusive_maximum: Option<N>) -> ObjectBuilder
where N: Into<Number>,

Available on crate feature rest only.

Set or change exclusive maximum value for number and integer values.

Source

pub fn exclusive_minimum<N>(self, exclusive_minimum: Option<N>) -> ObjectBuilder
where N: Into<Number>,

Available on crate feature rest only.

Set or change exclusive minimum value for number and integer values.

Source

pub fn max_length(self, max_length: Option<usize>) -> ObjectBuilder

Available on crate feature rest only.

Set or change maximum length for string values.

Source

pub fn min_length(self, min_length: Option<usize>) -> ObjectBuilder

Available on crate feature rest only.

Set or change minimum length for string values.

Source

pub fn pattern<I>(self, pattern: Option<I>) -> ObjectBuilder
where I: Into<String>,

Available on crate feature rest only.

Set or change a valid regular expression for string value to match.

Source

pub fn max_properties(self, max_properties: Option<usize>) -> ObjectBuilder

Available on crate feature rest only.

Set or change maximum number of properties the Object can hold.

Source

pub fn min_properties(self, min_properties: Option<usize>) -> ObjectBuilder

Available on crate feature rest only.

Set or change minimum number of properties the Object can hold.

Source

pub fn extensions(self, extensions: Option<Extensions>) -> ObjectBuilder

Available on crate feature rest only.

Add openapi extensions (x-something) for Object.

Source

pub fn content_encoding<S>(self, content_encoding: S) -> ObjectBuilder
where S: Into<String>,

Available on crate feature rest only.

Set of change Object::content_encoding. Typically left empty but could be base64 for example.

Source

pub fn content_media_type<S>(self, content_media_type: S) -> ObjectBuilder
where S: Into<String>,

Available on crate feature rest only.

Set of change Object::content_media_type. Value must be valid MIME type e.g. application/json.

Source

pub fn to_array_builder(self) -> ArrayBuilder

Available on crate feature rest only.

Construct a new ArrayBuilder with this component set to ArrayBuilder::items.

Trait Implementations§

Source§

impl Default for ObjectBuilder

Source§

fn default() -> ObjectBuilder

Returns the “default value” for a type. Read more
Source§

impl From<Object> for ObjectBuilder

Source§

fn from(value: Object) -> ObjectBuilder

Converts to this type from the input type.
Source§

impl From<ObjectBuilder> for AdditionalProperties<Schema>

Source§

fn from(value: ObjectBuilder) -> AdditionalProperties<Schema>

Converts to this type from the input type.
Source§

impl From<ObjectBuilder> for ArrayItems

Source§

fn from(value: ObjectBuilder) -> ArrayItems

Converts to this type from the input type.
Source§

impl From<ObjectBuilder> for Object

Source§

fn from(value: ObjectBuilder) -> Object

Converts to this type from the input type.
Source§

impl From<ObjectBuilder> for RefOr<Schema>

Source§

fn from(builder: ObjectBuilder) -> RefOr<Schema>

Converts to this type from the input type.
Source§

impl From<ObjectBuilder> for Schema

Source§

fn from(builder: ObjectBuilder) -> Schema

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<T> AnySync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = Infallible

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more