Skip to main content

MethodDescriptor

Struct MethodDescriptor 

Source
pub struct MethodDescriptor { /* private fields */ }
Expand description

A method definition for a ServiceDescriptor.

Implementations§

Source§

impl MethodDescriptor

Source

pub fn new(service: ServiceDescriptor, index: usize) -> MethodDescriptor

Create a new MethodDescriptor referencing the method at index within the ServiceDescriptor.

§Panics

Panics if index is out-of-bounds.

Source

pub fn index(&self) -> usize

Gets the index of the method within the parent ServiceDescriptor.

Source

pub fn parent_service(&self) -> &ServiceDescriptor

Gets a reference to the ServiceDescriptor this method is defined in.

Source

pub fn parent_pool(&self) -> &DescriptorPool

Gets a reference to the DescriptorPool this method is defined in.

Source

pub fn parent_file(&self) -> FileDescriptor

Gets the FileDescriptor this method is defined in.

Source

pub fn name(&self) -> &str

Gets the short name of the method, e.g. method.

Source

pub fn full_name(&self) -> &str

Gets the full name of the method, e.g. my.package.MyService.my_method.

Examples found in repository?
examples/reflection.rs (line 18)
12async fn main() -> Result<()> {
13    let request = ReflectionRequest::new("http://localhost:50051");
14    let desc = ProtoDescriptor::from_reflection(request).await?;
15    let service = &desc.get_services()[0];
16    let method = &desc.get_methods(service)[0];
17    println!("Service: {:}", service.full_name());
18    println!("Method:  {:}", method.full_name());
19    //
20    let mut req = desc.get_request(&method);
21    req.set_address("http://localhost:50051");
22
23    let mut req = desc.get_request(&method);
24    req.set_address("http://localhost:50051");
25
26    Ok(())
27}
More examples
Hide additional examples
examples/metadata.rs (line 19)
11async fn main() -> Result<()> {
12    let desc = ProtoDescriptor::new(
13        vec!["/Users/philippreiter/Rust/wireman/example"],
14        vec!["grpc_simple/debugger.proto"],
15    )?;
16    let service = &desc.get_services()[0];
17    let method = &desc.get_methods(service)[1];
18    println!("Service: {:}", service.full_name());
19    println!("Method:  {:}", method.full_name());
20
21    let mut req = desc.get_request(&method);
22    req.set_address("http://localhost:50051");
23
24    let resp = do_request(&req).await?;
25    println!("\nResponse:\n{:}", resp.message.to_json()?);
26
27    Ok(())
28}
Source

pub fn path(&self) -> &[i32]

Gets the path where this method is defined within the FileDescriptorProto, e.g. [6, 0, 2, 0].

See path for more details on the structure of the path.

Source

pub fn method_descriptor_proto(&self) -> &MethodDescriptorProto

Gets a reference to the raw MethodDescriptorProto wrapped by this MethodDescriptor.

Source

pub fn options(&self) -> DynamicMessage

Decodes the options defined for this MethodDescriptorProto, including any extension options.

Source

pub fn input(&self) -> MessageDescriptor

Gets the MessageDescriptor for the input type of this method.

Source

pub fn output(&self) -> MessageDescriptor

Gets the MessageDescriptor for the output type of this method.

Source

pub fn is_client_streaming(&self) -> bool

Returns true if the client streams multiple messages.

Source

pub fn is_server_streaming(&self) -> bool

Returns true if the server streams multiple messages.

Examples found in repository?
examples/streaming.rs (line 18)
9async fn main() -> Result<()> {
10    let desc = ProtoDescriptor::new(
11        vec!["/Users/philippreiter/Rust/wireman/example/server/streaming"],
12        vec!["streaming.proto"],
13    )?;
14
15    let service = &desc.get_services()[0];
16    let method = &desc.get_methods(service)[0];
17
18    if !method.is_server_streaming() {
19        println!("Method must be server streaming");
20    }
21
22    let mut request = desc.get_request(&method);
23    request.set_address("http://localhost:50051");
24
25    let response = call_server_streaming(&request, None).await?;
26
27    let mut pinned = std::pin::pin!(response);
28    let stream = pinned.as_mut().get_mut();
29
30    while let Some(message) = stream.next().await {
31        let message = message?;
32        println!("message: {:?}", message.message);
33        println!();
34    }
35
36    Ok(())
37}

Trait Implementations§

Source§

impl Clone for MethodDescriptor

Source§

fn clone(&self) -> MethodDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MethodDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MethodDescriptor

Source§

impl PartialEq for MethodDescriptor

Source§

fn eq(&self, other: &MethodDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for MethodDescriptor

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<L> LayerExt<L> for L

Source§

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.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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