Struct vfs::object_request::ObjectRequest

source ·
pub struct ObjectRequest {
    pub truncate: bool,
    /* private fields */
}
Expand description

Wraps the channel provided in the open methods and provide convenience methods for sending appropriate responses. It also records actions that should be taken upon successful connection such as truncating file objects.

Fields§

§truncate: bool

Truncate the object before use.

Implementations§

source§

impl ObjectRequest

source

pub fn new3(flags: Flags, options: &Options, object_request: Channel) -> Self

source

pub fn attributes(&self) -> NodeAttributesQuery

source

pub fn create_attributes(&self) -> Option<&MutableNodeAttributes>

source

pub fn options(&self) -> Options

source

pub async fn into_request_stream<T: Representation>( self, connection: &T, ) -> Result<<T::Protocol as ProtocolMarker>::RequestStream, Status>

Returns the request stream after sending requested information.

source

pub fn into_server_end<T>(self) -> ServerEnd<T>

Converts to ServerEnd.

source

pub fn into_channel(self) -> Channel

Extracts the channel (without sending on_open).

source

pub fn into_channel_after_sending_on_open( self, node_info: NodeInfoDeprecated, ) -> Result<Channel, Status>

Extracts the channel after sending on_open.

source

pub fn shutdown(self, status: Status)

Terminates the object request with the given status.

source

pub fn handle<T>( self, f: impl FnOnce(ObjectRequestRef<'_>) -> Result<T, Status>, ) -> Option<T>

Calls f and sends an error on the object request channel upon failure.

source

pub fn spawn<F, Fut>(self, scope: &ExecutionScope, f: F)
where for<'a> F: FnOnce(ObjectRequestRef<'a>) -> BoxFuture<'a, Result<Fut, Status>> + Send + 'static, Fut: Future<Output = ()> + Send,

Spawn a task for the object request. The callback returns a future that can return a Status which will be handled appropriately. If the future succeeds it should return another future that is responsible for the long term servicing of the object request. This is done to avoid paying the stack cost of the object request for the lifetime of the connection.

For example:

object_request.spawn( scope, move |object_request| Box::pin(async move { // Perform checks on the new connection if !valid(…) { return Err(Status::INVALID_ARGS); } // Upon success, return a future that handles the connection. let requests = object_request.take().into_request_stream(); Ok(async { while let request = requests.next().await { … } }) }));

source

pub async fn wait_till_ready(&self) -> bool

Waits until the request has a request waiting in its channel. Returns immediately if this request requires sending an initial event such as OnOpen or OnRepresentation. Returns true if the channel is readable (rather than just closed).

source

pub fn take(&mut self) -> ObjectRequest

Take the ObjectRequest. The caller is responsible for sending errors.

source

pub fn create_connection<N: Node, F: Future<Output = ()> + Send + 'static, P: ProtocolsExt>( &mut self, scope: ExecutionScope, node: Arc<N>, protocols: P, f: impl FnOnce(ExecutionScope, Arc<N>, P, &mut Self) -> Result<F, Status>, ) -> Result<BoxFuture<'static, ()>, Status>

Returns a future that will run the connection. f is a callback that returns a future that will run the connection but it will not be called if the connection is supposed to be a node connection.

source

pub fn spawn_connection<N: Node, F: Future<Output = ()> + Send + 'static, P: ProtocolsExt>( &mut self, scope: ExecutionScope, node: Arc<N>, protocols: P, f: impl FnOnce(ExecutionScope, Arc<N>, P, &mut Self) -> Result<F, Status>, ) -> Result<(), Status>

Spawns a new connection for this request. f is similar to create_connection above.

Trait Implementations§

source§

impl Debug for ObjectRequest

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, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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
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> IntoAny for T
where T: 'static + Send + Sync,

source§

fn into_any(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Cast the given object into a dyn std::any::Any.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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