OperationBuilder

Struct OperationBuilder 

Source
pub struct OperationBuilder {
    pub name: Option<OperationName>,
    pub http_method: Option<OperationHttpMethod>,
    pub http_path: Option<OperationHttpPath>,
}
Expand description

Builder struct used to gradually build an Operation instance.

Fields§

§name: Option<OperationName>§http_method: Option<OperationHttpMethod>§http_path: Option<OperationHttpPath>

Implementations§

Source§

impl OperationBuilder

Source

pub fn with_operation_name(self, operation_name: OperationName) -> Self

Sets the operation name in the builder.

This method allows you to set the name field of the Operation object that will be constructed. The operation name typically corresponds to the action or API endpoint (e.g., “GetUser”, “CreateUser”).

§Arguments
  • operation_name - The name of the operation (e.g., “GetUser”).
§Returns

The builder with the updated operation name.

Source

pub fn with_operation_http_method( self, operation_http_method: OperationHttpMethod, ) -> Self

Sets the HTTP method in the builder.

This method allows you to set the http_method field of the Operation object that will be constructed. The HTTP method determines whether the request will use GET, POST, PUT, etc.

§Arguments
  • operation_http_method - The HTTP method for the operation (e.g., GET, POST).
§Returns

The builder with the updated HTTP method.

Source

pub fn with_operation_http_path( self, operation_http_path: OperationHttpPath, ) -> Self

Sets the HTTP path in the builder.

This method allows you to set the http_path field of the Operation object that will be constructed. The HTTP path defines the specific API endpoint or route for the operation (e.g., “/user”, “/product”).

§Arguments
  • operation_http_path - The HTTP path for the operation (e.g., “/user”).
§Returns

The builder with the updated HTTP path.

Source

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

Finalizes the builder and creates an Operation instance.

This method validates the required fields and constructs the Operation object. If any required fields are missing, it returns an error. Otherwise, it returns the fully constructed Operation.

§Returns
  • Ok(Operation) - A fully constructed Operation if all fields are provided.
  • Err(Error) - An error if any required fields are missing.

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> 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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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
Source§

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