Skip to main content

Operation

Struct Operation

pub struct Operation<In, Out> {
    pub id: String,
    pub method: String,
    pub title: String,
    pub description: String,
    pub allowed_roles: Vec<String>,
    pub tags: Vec<String>,
    pub read_only: bool,
    pub visible: Option<bool>,
    /* private fields */
}

Expand description

Describes one statically declared executable operation.

Fields§

§id: String

Stable operation id.

§method: String

HTTP method advertised in the catalog.

§title: String

Human-readable title.

§description: String

Human-readable description.

§allowed_roles: Vec<String>

Host-side roles allowed to invoke the operation.

§tags: Vec<String>

Free-form catalog tags.

§read_only: bool

Whether the operation is read-only.

§visible: Option<bool>

Optional catalog visibility override.

Implementations§

impl<In, Out> Operation<In, Out>
where In: JsonSchema, Out: JsonSchema,

pub fn new(id: impl Into<String>) -> Self

Creates a new operation definition with the supplied stable id.

pub fn method(self, method: impl AsRef<str>) -> Self

Overrides the HTTP verb advertised in the derived catalog.

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

Sets the human-readable title shown in the derived catalog.

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

Sets the human-readable description shown in the derived catalog.

pub fn allowed_roles(self, allowed_roles: impl Into<Vec<String>>) -> Self

Restricts the operation to the supplied host-side roles.

pub fn tags(self, tags: impl Into<Vec<String>>) -> Self

Attaches free-form tags to the derived catalog entry.

pub fn read_only(self, read_only: bool) -> Self

Marks the operation as read-only in the derived catalog.

pub fn visible(self, visible: bool) -> Self

Controls whether the operation should be visible to callers.

Trait Implementations§

impl<In: Clone, Out: Clone> Clone for Operation<In, Out>

fn clone(&self) -> Operation<In, Out>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<In: Debug, Out: Debug> Debug for Operation<In, Out>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<In, Out> Freeze for Operation<In, Out>

impl<In, Out> RefUnwindSafe for Operation<In, Out>
where In: RefUnwindSafe, Out: RefUnwindSafe,

impl<In, Out> Send for Operation<In, Out>
where In: Send, Out: Send,

impl<In, Out> Sync for Operation<In, Out>
where In: Sync, Out: Sync,

impl<In, Out> Unpin for Operation<In, Out>
where In: Unpin, Out: Unpin,

impl<In, Out> UnsafeUnpin for Operation<In, Out>

impl<In, Out> UnwindSafe for Operation<In, Out>
where In: UnwindSafe, Out: 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> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

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.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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