Struct RpEndpoint

pub struct RpEndpoint<F>
where
    F: Flavor + 'static,
{
    pub ident: String,
    pub safe_ident: Option<String>,
    pub name: Option<String>,
    pub comment: Vec<String>,
    pub attributes: Attributes,
    pub arguments: Vec<RpEndpointArgument<F>>,
    pub request: Option<RpEndpointArgument<F>>,
    pub response: Option<Loc<RpChannel<F>>>,
    pub http: RpEndpointHttp<F>,
}

Fields

ident: String

Name of the endpoint. Guaranteed to be unique.

safe_ident: Option<String>

Safe identifier of the endpoint, avoiding any language-specific keywords.

name: Option<String>

Name of the endpoint. This is the name which is being sent over the wire.

comment: Vec<String>

Comments for documentation.

attributes: Attributes

Attributes associated with the endpoint.

arguments: Vec<RpEndpointArgument<F>>

Request type that this endpoint expects.

request: Option<RpEndpointArgument<F>>

Request type that this endpoint accepts with.

response: Option<Loc<RpChannel<F>>>

Response type that this endpoint responds with.

http: RpEndpointHttp<F>

HTTP configuration.

Implementations

impl<F> RpEndpoint<F>

where F: Flavor + 'static,

pub fn id_parts<T>(&self, filter: T) -> Vec<String>

where T: Fn(&str) -> String,

pub fn name(&self) -> &str

Get the name of the endpoint.

pub fn safe_ident(&self) -> &str

Safe identifier of the endpoint.

pub fn ident(&self) -> &str

Get the identifier of the endpoint.

pub fn has_http_support(&self) -> bool

If endpoint has metadata for HTTP.

Trait Implementations

impl<F> Clone for RpEndpoint<F>

where F: Flavor + Clone + 'static,

fn clone(&self) -> RpEndpoint<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for RpEndpoint<F>

where F: Flavor + Debug + 'static,

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

Formats the value using the given formatter.

impl<F> Serialize for RpEndpoint<F>

where F: Flavor + Serialize + 'static, F::Type: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F, T> Translate<T> for RpEndpoint<F>

where F: Flavor + 'static, T: Translator<Source = F>,

fn translate( self, diag: &mut Diagnostics, translator: &T, ) -> Result<RpEndpoint<T::Target>>

Translate into different flavor.

type Source = F

type Out = RpEndpoint<<T as Translator>::Target>