latitude_sdk::models::document

Struct RunDocumentBuilder

pub struct RunDocumentBuilder<T>where
    T: Serialize + Default,{
    pub path: Option<String>,
    pub parameters: Option<T>,
    pub stream: Option<bool>,
    pub options: Option<Options>,
}

Expand description

A builder for creating RunDocument instances.

This builder allows you to set optional fields, such as parameters, before building the RunDocument instance. By default, if parameters is not set, it will use T::default().

Fields§

§path: Option<String>§parameters: Option<T>§stream: Option<bool>§options: Option<Options>

Implementations§

impl<T> RunDocumentBuilder<T>
where T: Serialize + Default,

pub fn path(self, path: String) -> Self

Sets the path for the RunDocument.

§Arguments

path - The path of the document to be run.

pub fn parameters(self, parameters: T) -> Self

Sets the optional parameters for the RunDocument.

§Arguments

parameters - Optional parameters for the document.

pub fn stream(self) -> Self

Sets the stream options for the RunDocument.

§Arguments

stream - Boolean indicating if the response should be streamed.

pub fn options(self, options: Options) -> Self

Sets the Options for the RunDocument.

§Arguments

options - The options to be set in the configuration.

pub fn build(self) -> Result<RunDocument<T>, Error>

Builds the RunDocument instance with the specified parameters.

If parameters is not provided, it will default to T::default(). If stream is not provided, it will default to false.

§Returns

A RunDocument instance.

Trait Implementations§

impl<T> Default for RunDocumentBuilder<T>
where T: Serialize + Default,

fn default() -> Self

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

Auto Trait Implementations§

impl<T> Freeze for RunDocumentBuilder<T>
where T: Freeze,

impl<T> RefUnwindSafe for RunDocumentBuilder<T>
where T: RefUnwindSafe,

impl<T> Send for RunDocumentBuilder<T>
where T: Send,

impl<T> Sync for RunDocumentBuilder<T>
where T: Sync,

impl<T> Unpin for RunDocumentBuilder<T>
where T: Unpin,

impl<T> UnwindSafe for RunDocumentBuilder<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,