Struct Status 

pub struct Status(/* private fields */);

Status type indicating the result of a Fuchsia syscall.

This type is generally used to indicate the reason for an error. While this type can contain Status::OK (ZX_OK in C land), elements of this type are generally constructed using the ok method, which checks for ZX_OK and returns a Result<(), Status> appropriately.

Implementations

impl Status

pub fn ok(raw: zx_status_t) -> Result<(), Status>

Returns Ok(()) if the status was OK, otherwise returns Err(status).

pub fn from_raw(raw: zx_status_t) -> Self

pub fn into_raw(self) -> zx_status_t

impl Status

pub const OK: Status

Indicates an operation was successful.

pub const INTERNAL: Status

The system encountered an otherwise unspecified error while performing the operation.

pub const NOT_SUPPORTED: Status

The operation is not implemented, supported, or enabled.

pub const NO_RESOURCES: Status

The system was not able to allocate some resource needed for the operation.

pub const NO_MEMORY: Status

The system was not able to allocate memory needed for the operation.

pub const INTERRUPTED_RETRY: Status

The system call was interrupted, but should be retried. This should not be seen outside of the VDSO.

pub const INVALID_ARGS: Status

An argument is invalid. For example, a null pointer when a null pointer is not permitted.

pub const BAD_HANDLE: Status

A specified handle value does not refer to a handle.

pub const WRONG_TYPE: Status

The subject of the operation is the wrong type to perform the operation.

For example: Attempting a message_read on a thread handle.

pub const BAD_SYSCALL: Status

The specified syscall number is invalid.

pub const OUT_OF_RANGE: Status

An argument is outside the valid range for this operation.

pub const BUFFER_TOO_SMALL: Status

The caller-provided buffer is too small for this operation.

pub const BAD_STATE: Status

The operation failed because the current state of the object does not allow it, or a precondition of the operation is not satisfied.

pub const TIMED_OUT: Status

The time limit for the operation elapsed before the operation completed.

pub const SHOULD_WAIT: Status

The operation cannot be performed currently but potentially could succeed if the caller waits for a prerequisite to be satisfied, like waiting for a handle to be readable or writable.

Example: Attempting to read from a channel that has no messages waiting but has an open remote will return ZX_ERR_SHOULD_WAIT. In contrast, attempting to read from a channel that has no messages waiting and has a closed remote end will return ZX_ERR_PEER_CLOSED.

pub const CANCELED: Status

The in-progress operation, for example, a wait, has been canceled.

pub const PEER_CLOSED: Status

The operation failed because the remote end of the subject of the operation was closed.

pub const NOT_FOUND: Status

The requested entity is not found.

pub const ALREADY_EXISTS: Status

An object with the specified identifier already exists.

Example: Attempting to create a file when a file already exists with that name.

pub const ALREADY_BOUND: Status

The operation failed because the named entity is already owned or controlled by another entity. The operation could succeed later if the current owner releases the entity.

pub const UNAVAILABLE: Status

The subject of the operation is currently unable to perform the operation.

This is used when there’s no direct way for the caller to observe when the subject will be able to perform the operation and should thus retry.

pub const ACCESS_DENIED: Status

The caller did not have permission to perform the specified operation.

pub const IO: Status

Otherwise-unspecified error occurred during I/O.

pub const IO_REFUSED: Status

The entity the I/O operation is being performed on rejected the operation.

Example: an I2C device NAK’ing a transaction or a disk controller rejecting an invalid command, or a stalled USB endpoint.

pub const IO_DATA_INTEGRITY: Status

The data in the operation failed an integrity check and is possibly corrupted.

Example: CRC or Parity error.

pub const IO_DATA_LOSS: Status

The data in the operation is currently unavailable and may be permanently lost.

Example: A disk block is irrecoverably damaged.

pub const IO_NOT_PRESENT: Status

The device is no longer available (has been unplugged from the system, powered down, or the driver has been unloaded).

pub const IO_OVERRUN: Status

More data was received from the device than expected.

Example: a USB “babble” error due to a device sending more data than the host queued to receive.

pub const IO_MISSED_DEADLINE: Status

An operation did not complete within the required timeframe.

Example: A USB isochronous transfer that failed to complete due to an overrun or underrun.

pub const IO_INVALID: Status

The data in the operation is invalid parameter or is out of range.

Example: A USB transfer that failed to complete with TRB Error

pub const BAD_PATH: Status

Path name is too long.

pub const NOT_DIR: Status

The object is not a directory or does not support directory operations.

Example: Attempted to open a file as a directory or attempted to do directory operations on a file.

pub const NOT_FILE: Status

Object is not a regular file.

pub const FILE_BIG: Status

This operation would cause a file to exceed a filesystem-specific size limit.

pub const NO_SPACE: Status

The filesystem or device space is exhausted.

pub const NOT_EMPTY: Status

The directory is not empty for an operation that requires it to be empty.

For example, non-recursively deleting a directory with files still in it.

pub const STOP: Status

An indicate to not call again.

The flow control values ZX_ERR_STOP, ZX_ERR_NEXT, and ZX_ERR_ASYNC are not errors and will never be returned by a system call or public API. They allow callbacks to request their caller perform some other operation.

For example, a callback might be called on every event until it returns something other than ZX_OK. This status allows differentiation between “stop due to an error” and “stop because work is done.”

pub const NEXT: Status

Advance to the next item.

The flow control values ZX_ERR_STOP, ZX_ERR_NEXT, and ZX_ERR_ASYNC are not errors and will never be returned by a system call or public API. They allow callbacks to request their caller perform some other operation.

For example, a callback could use this value to indicate it did not consume an item passed to it, but by choice, not due to an error condition.

pub const ASYNC: Status

Ownership of the item has moved to an asynchronous worker.

The flow control values ZX_ERR_STOP, ZX_ERR_NEXT, and ZX_ERR_ASYNC are not errors and will never be returned by a system call or public API. They allow callbacks to request their caller perform some other operation.

Unlike ZX_ERR_STOP, which implies that iteration on an object should stop, and ZX_ERR_NEXT, which implies that iteration should continue to the next item, ZX_ERR_ASYNC implies that an asynchronous worker is responsible for continuing iteration.

For example, a callback will be called on every event, but one event needs to handle some work asynchronously before it can continue. ZX_ERR_ASYNC implies the worker is responsible for resuming iteration once its work has completed.

pub const PROTOCOL_NOT_SUPPORTED: Status

The specified protocol is not supported.

pub const ADDRESS_UNREACHABLE: Status

The host is unreachable.

pub const ADDRESS_IN_USE: Status

Address is being used by someone else.

pub const NOT_CONNECTED: Status

The socket is not connected.

pub const CONNECTION_REFUSED: Status

The remote peer rejected the connection.

pub const CONNECTION_RESET: Status

The connection was reset.

pub const CONNECTION_ABORTED: Status

The connection was aborted.

impl Status

pub fn into_io_error(self) -> Error

pub fn from_result(res: Result<(), Self>) -> Self

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.

impl Error for Status

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Status

fn from(err: Error) -> Status

Converts to this type from the input type.

impl From<ErrorKind> for Status

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.

impl From<NulError> for Status

fn from(_error: NulError) -> Status

Converts to this type from the input type.

impl From<Result<(), Status>> for Status

fn from(res: Result<(), Status>) -> Status

Converts to this type from the input type.

impl From<Status> for Error

fn from(status: Status) -> Error

Converts to this type from the input type.

impl From<Status> for ErrorKind

fn from(status: Status) -> ErrorKind

Converts to this type from the input type.

impl From<Status> for Result<(), Status>

fn from(src: Status) -> Result<(), Status>

Converts to this type from the input type.

impl Hash for Status

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Status

fn cmp(&self, other: &Status) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Status

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Status

impl Eq for Status

impl StructuralPartialEq for Status