CommandResponseTraitMethod

Struct CommandResponseTraitMethod 

Source
pub struct CommandResponseTraitMethod<'a> {
    pub command: &'a RecordType,
    pub response: &'a DiscriminatedUnionType,
    pub shapes: &'a [RecordType],
}
Expand description

Generates the provided trait method for the ClientApi trait.

The ClientApi trait definition itself must be generated by the client and should look like this

pub trait ClientApi {
    type Error;

    fn send_raw(&self, command: String) -> impl Future<Output = Result<Arc<{}>, Self::Error>> + Send;

    //..
}

Then the provided methods could be inserted.

For methods that return multiple kinds a valid responses the additional wrapper type should be generated. You can get this type definition using the CommandResponseTraitMethod::response_wrapper method.

Fields§

§command: &'a RecordType§response: &'a DiscriminatedUnionType§shapes: &'a [RecordType]

Implementations§

Source§

impl<'a> CommandResponseTraitMethod<'a>

Source

pub fn new( command: &'a RecordType, response: &'a DiscriminatedUnionType, shapes: &'a [RecordType], ) -> Self

Source§

impl<'a> CommandResponseTraitMethod<'a>

Source

pub fn response_wrapper(&self) -> Option<ResponseWrapperFmt>

If some method has multiple valid responses a helper type representing valid response variants must be generated.

If only one possible valid response is possible it can get inlined without extra helper types and for this case this method returns None.

Trait Implementations§

Source§

impl<'a> Display for CommandResponseTraitMethod<'a>

Source§

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

Formats the value using the given formatter. Read more

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, 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.