Struct vfs::directory::entry::OpenRequest

pub struct OpenRequest<'a> { /* private fields */ }

An open request.

Implementations

impl<'a> OpenRequest<'a>

pub fn new( scope: ExecutionScope, request_flags: impl Into<RequestFlags>, path: Path, object_request: ObjectRequestRef<'a>, ) -> Self

Creates a new open request.

pub fn path(&self) -> &Path

Returns the path for this request.

pub fn prepend_path(&mut self, prefix: &Path)

Prepends prefix to the path.

pub fn set_path(&mut self, path: Path)

Sets the path to path.

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 clased).

pub fn requires_event(&self) -> bool

Returns true if the request requires the server to send an event (e.g. either OnOpen or OnRepresentation). If true, wait_till_ready will return immediately. If false, the caller might choose to call wait_till_ready if other conditions are satisfied (checking for an empty path is usually a good idea since it is hard to know where a non-empty path might end up being terminated).

pub fn open_dir(self, dir: Arc<impl Directory>) -> Result<(), Status>

Opens a directory.

pub fn open_file(self, file: Arc<impl FileLike>) -> Result<(), Status>

Opens a file.

pub fn open_symlink(self, service: Arc<impl Symlink>) -> Result<(), Status>

Opens a symlink.

pub fn open_service(self, service: Arc<impl ServiceLike>) -> Result<(), Status>

Opens a service.

pub fn open_remote( self, remote: Arc<impl RemoteLike + Send + Sync + 'static>, ) -> Result<(), Status>

Forwards the request to a remote.

pub fn spawn(self, entry: Arc<impl DirectoryEntryAsync>)

Spawns a task to handle the request. entry must implement DirectoryEntryAsync.

pub fn scope(&self) -> &ExecutionScope

Returns the execution scope for this request.

pub fn set_scope(&mut self, scope: ExecutionScope)

Replaces the scope in this request. This is the right thing to do if any subsequently spawned tasks should be in a different scope to the task that received this open request.

Trait Implementations

impl<'a> Debug for OpenRequest<'a>

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

Formats the value using the given formatter.