Skip to main content

ControlFile

Struct ControlFile 

Source
pub struct ControlFile<F> { /* private fields */ }
Expand description

A Plan 9-style ctl file: writing bytes invokes a caller-supplied async handler, whose result is latched and served on the next read.

Generic over the handler closure F. Construct with ControlFile::new; the closure receives the written bytes by value (Vec<u8>, not &[u8]) and returns a boxed 'static future resolving to the response bytes, or a MountError (rendered as-is — callers that want Wanix-style "error: ..." text on the read side should fold that into F’s Ok arm rather than returning Err, exactly as both TclMount/PythonMount already do for interpreter-level errors).

Taking owned bytes (rather than &[u8]) is a deliberate API choice: a Fn(&'a [u8]) -> DevFuture<'a, _> would need to be higher-ranked over 'a (for<'a> Fn(&'a [u8]) -> ...), which closures capturing moved state can satisfy in principle but which the compiler frequently fails to infer for boxed closure literals in practice (the closure’s Fn impl collapses to one concrete lifetime instead of being universally quantified). Owned input avoids the whole class of error and mirrors how both existing mounts already shuttle owned String/Vec<u8> across their command channels.

§Fid contract

Use ControlFile::new_fid in Mount::walk to create the per-open [Fid]; call ControlFile::handle_write from Mount::write and ControlFile::handle_read from Mount::read.

Implementations§

Source§

impl<F> ControlFile<F>
where F: Fn(Vec<u8>) -> DevFuture<'static, Result<Vec<u8>, MountError>> + Send + Sync,

Source

pub fn new(handler: F) -> Self

Build a control file around an async handler.

Source

pub fn new_fid(&self) -> DevFileState

Fresh per-fid latch state for this ctl file (nothing written yet).

Source

pub async fn handle_write( &self, state: &DevFileState, data: &[u8], ) -> Result<u32, MountError>

Handle a Mount::write: run the handler over data, latch the result (or an "error: ..."-free propagation — the error is returned directly, NOT latched, matching Mount::write’s Result surface) into state, and return the byte count written on success.

Source

pub fn handle_read(&self, state: &DevFileState, offset: u64) -> Vec<u8> ⓘ

Handle a Mount::read: serve the latched result (empty if nothing has been written yet), sliced from offset.

Auto Trait Implementations§

§

impl<F> Freeze for ControlFile<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for ControlFile<F>
where F: RefUnwindSafe,

§

impl<F> Send for ControlFile<F>
where F: Send,

§

impl<F> Sync for ControlFile<F>
where F: Sync,

§

impl<F> Unpin for ControlFile<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for ControlFile<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for ControlFile<F>
where F: UnwindSafe,

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.

§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. 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.
§

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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,