Struct bevy::tasks::futures_lite::io::Error

1.0.0 · source ·
pub struct Error { /* private fields */ }
Available on crate feature std only.
Expand description

The error type for I/O operations of the Read, Write, Seek, and associated traits.

Errors mostly originate from the underlying OS, but custom instances of Error can be created with crafted error messages and a particular value of ErrorKind.

Implementations§

source§

impl Error

This impl block contains no items.

Common errors constants for use in std

source§

impl Error

1.0.0 · source

pub fn new<E>(kind: ErrorKind, error: E) -> Error
where E: Into<Box<dyn Error + Send + Sync>>,

Creates a new I/O error from a known kind of error as well as an arbitrary error payload.

This function is used to generically create I/O errors which do not originate from the OS itself. The error argument is an arbitrary payload which will be contained in this Error.

Note that this function allocates memory on the heap. If no extra payload is required, use the From conversion from ErrorKind.

§Examples
use std::io::{Error, ErrorKind};

// errors can be created from strings
let custom_error = Error::new(ErrorKind::Other, "oh no!");

// errors can also be created from other errors
let custom_error2 = Error::new(ErrorKind::Interrupted, custom_error);

// creating an error without payload (and without memory allocation)
let eof_error = Error::from(ErrorKind::UnexpectedEof);
1.74.0 · source

pub fn other<E>(error: E) -> Error
where E: Into<Box<dyn Error + Send + Sync>>,

Creates a new I/O error from an arbitrary error payload.

This function is used to generically create I/O errors which do not originate from the OS itself. It is a shortcut for Error::new with ErrorKind::Other.

§Examples
use std::io::Error;

// errors can be created from strings
let custom_error = Error::other("oh no!");

// errors can also be created from other errors
let custom_error2 = Error::other(custom_error);
1.0.0 · source

pub fn last_os_error() -> Error

Returns an error representing the last OS error which occurred.

This function reads the value of errno for the target platform (e.g. GetLastError on Windows) and will return a corresponding instance of Error for the error code.

This should be called immediately after a call to a platform function, otherwise the state of the error value is indeterminate. In particular, other standard library functions may call platform functions that may (or may not) reset the error value even if they succeed.

§Examples
use std::io::Error;

let os_error = Error::last_os_error();
println!("last OS error: {os_error:?}");
1.0.0 · source

pub fn from_raw_os_error(code: i32) -> Error

Creates a new instance of an Error from a particular OS error code.

§Examples

On Linux:

use std::io;

let error = io::Error::from_raw_os_error(22);
assert_eq!(error.kind(), io::ErrorKind::InvalidInput);

On Windows:

use std::io;

let error = io::Error::from_raw_os_error(10022);
assert_eq!(error.kind(), io::ErrorKind::InvalidInput);
1.0.0 · source

pub fn raw_os_error(&self) -> Option<i32>

Returns the OS error that this error represents (if any).

If this Error was constructed via last_os_error or from_raw_os_error, then this function will return Some, otherwise it will return None.

§Examples
use std::io::{Error, ErrorKind};

fn print_os_error(err: &Error) {
    if let Some(raw_os_err) = err.raw_os_error() {
        println!("raw OS error: {raw_os_err:?}");
    } else {
        println!("Not an OS error");
    }
}

fn main() {
    // Will print "raw OS error: ...".
    print_os_error(&Error::last_os_error());
    // Will print "Not an OS error".
    print_os_error(&Error::new(ErrorKind::Other, "oh no!"));
}
1.3.0 · source

pub fn get_ref(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

Returns a reference to the inner error wrapped by this error (if any).

If this Error was constructed via new then this function will return Some, otherwise it will return None.

§Examples
use std::io::{Error, ErrorKind};

fn print_error(err: &Error) {
    if let Some(inner_err) = err.get_ref() {
        println!("Inner error: {inner_err:?}");
    } else {
        println!("No inner error");
    }
}

fn main() {
    // Will print "No inner error".
    print_error(&Error::last_os_error());
    // Will print "Inner error: ...".
    print_error(&Error::new(ErrorKind::Other, "oh no!"));
}
1.3.0 · source

pub fn get_mut(&mut self) -> Option<&mut (dyn Error + Send + Sync + 'static)>

Returns a mutable reference to the inner error wrapped by this error (if any).

If this Error was constructed via new then this function will return Some, otherwise it will return None.

§Examples
use std::io::{Error, ErrorKind};
use std::{error, fmt};
use std::fmt::Display;

#[derive(Debug)]
struct MyError {
    v: String,
}

impl MyError {
    fn new() -> MyError {
        MyError {
            v: "oh no!".to_string()
        }
    }

    fn change_message(&mut self, new_message: &str) {
        self.v = new_message.to_string();
    }
}

impl error::Error for MyError {}

impl Display for MyError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "MyError: {}", &self.v)
    }
}

fn change_error(mut err: Error) -> Error {
    if let Some(inner_err) = err.get_mut() {
        inner_err.downcast_mut::<MyError>().unwrap().change_message("I've been changed!");
    }
    err
}

fn print_error(err: &Error) {
    if let Some(inner_err) = err.get_ref() {
        println!("Inner error: {inner_err}");
    } else {
        println!("No inner error");
    }
}

fn main() {
    // Will print "No inner error".
    print_error(&change_error(Error::last_os_error()));
    // Will print "Inner error: ...".
    print_error(&change_error(Error::new(ErrorKind::Other, MyError::new())));
}
1.3.0 · source

pub fn into_inner(self) -> Option<Box<dyn Error + Send + Sync>>

Consumes the Error, returning its inner error (if any).

If this Error was constructed via new then this function will return Some, otherwise it will return None.

§Examples
use std::io::{Error, ErrorKind};

fn print_error(err: Error) {
    if let Some(inner_err) = err.into_inner() {
        println!("Inner error: {inner_err}");
    } else {
        println!("No inner error");
    }
}

fn main() {
    // Will print "No inner error".
    print_error(Error::last_os_error());
    // Will print "Inner error: ...".
    print_error(Error::new(ErrorKind::Other, "oh no!"));
}
1.79.0 · source

pub fn downcast<E>(self) -> Result<E, Error>
where E: Error + Send + Sync + 'static,

Attempt to downcast the custom boxed error to E.

If this Error contains a custom boxed error, then it would attempt downcasting on the boxed error, otherwise it will return Err.

If the custom boxed error has the same type as E, it will return Ok, otherwise it will also return Err.

This method is meant to be a convenience routine for calling Box<dyn Error + Sync + Send>::downcast on the custom boxed error, returned by Error::into_inner.

§Examples
use std::fmt;
use std::io;
use std::error::Error;

#[derive(Debug)]
enum E {
    Io(io::Error),
    SomeOtherVariant,
}

impl fmt::Display for E {
   // ...
}
impl Error for E {}

impl From<io::Error> for E {
    fn from(err: io::Error) -> E {
        err.downcast::<E>()
            .unwrap_or_else(E::Io)
    }
}

impl From<E> for io::Error {
    fn from(err: E) -> io::Error {
        match err {
            E::Io(io_error) => io_error,
            e => io::Error::new(io::ErrorKind::Other, e),
        }
    }
}

let e = E::SomeOtherVariant;
// Convert it to an io::Error
let io_error = io::Error::from(e);
// Cast it back to the original variant
let e = E::from(io_error);
assert!(matches!(e, E::SomeOtherVariant));

let io_error = io::Error::from(io::ErrorKind::AlreadyExists);
// Convert it to E
let e = E::from(io_error);
// Cast it back to the original variant
let io_error = io::Error::from(e);
assert_eq!(io_error.kind(), io::ErrorKind::AlreadyExists);
assert!(io_error.get_ref().is_none());
assert!(io_error.raw_os_error().is_none());
1.0.0 · source

pub fn kind(&self) -> ErrorKind

Returns the corresponding ErrorKind for this error.

This may be a value set by Rust code constructing custom io::Errors, or if this io::Error was sourced from the operating system, it will be a value inferred from the system’s error encoding. See last_os_error for more details.

§Examples
use std::io::{Error, ErrorKind};

fn print_error(err: Error) {
    println!("{:?}", err.kind());
}

fn main() {
    // As no error has (visibly) occurred, this may print anything!
    // It likely prints a placeholder for unidentified (non-)errors.
    print_error(Error::last_os_error());
    // Will print "AddrInUse".
    print_error(Error::new(ErrorKind::AddrInUse, "oh no!"));
}

Trait Implementations§

1.0.0 · source§

impl Debug for Error

source§

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

Formats the value using the given formatter. Read more
1.0.0 · source§

impl Display for Error

source§

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

Formats the value using the given formatter. Read more
1.0.0 · source§

impl Error for Error

source§

fn description(&self) -> &str

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

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

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

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

The lower-level source of this error, if any. Read more
source§

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. Read more
source§

impl From<CompressError> for Error

source§

fn from(data: CompressError) -> Error

Converts to this type from the input type.
§

impl From<DecodingError> for Error

§

fn from(err: DecodingError) -> Error

Converts to this type from the input type.
source§

impl From<DecompressError> for Error

source§

fn from(data: DecompressError) -> Error

Converts to this type from the input type.
§

impl From<EncodingError> for Error

§

fn from(err: EncodingError) -> Error

Converts to this type from the input type.
§

impl From<Errno> for Error

§

fn from(err: Errno) -> Error

Converts to this type from the input type.
§

impl From<Errno> for Error

§

fn from(err: Errno) -> Error

Converts to this type from the input type.
§

impl From<Errno> for Error

§

fn from(err: Errno) -> Error

Converts to this type from the input type.
§

impl From<Errno> for Error

§

fn from(err: Errno) -> Error

Converts to this type from the input type.
§

impl From<Error> for AnimationGraphLoadError

§

fn from(source: Error) -> AnimationGraphLoadError

Converts to this type from the input type.
§

impl From<Error> for AssetReaderError

§

fn from(value: Error) -> AssetReaderError

Converts to this type from the input type.
§

impl From<Error> for AssetWriterError

§

fn from(source: Error) -> AssetWriterError

Converts to this type from the input type.
§

impl From<Error> for AtspiError

§

fn from(e: Error) -> AtspiError

Converts to this type from the input type.
§

impl From<Error> for BlockHeaderReadError

§

fn from(original: Error) -> BlockHeaderReadError

Converts to this type from the input type.
source§

impl From<Error> for Box<ErrorKind>

source§

fn from(err: Error) -> Box<ErrorKind>

Converts to this type from the input type.
§

impl From<Error> for CompressedImageSaverError

§

fn from(source: Error) -> CompressedImageSaverError

Converts to this type from the input type.
§

impl From<Error> for ConnectError

§

fn from(err: Error) -> ConnectError

Converts to this type from the input type.
§

impl From<Error> for ConnectionError

§

fn from(err: Error) -> ConnectionError

Converts to this type from the input type.
§

impl From<Error> for CreateBufferError

§

fn from(source: Error) -> CreateBufferError

Converts to this type from the input type.
§

impl From<Error> for CreatePoolError

§

fn from(source: Error) -> CreatePoolError

Converts to this type from the input type.
§

impl From<Error> for DecodingError

§

fn from(err: Error) -> DecodingError

Converts to this type from the input type.
§

impl From<Error> for DecodingError

§

fn from(source: Error) -> DecodingError

Converts to this type from the input type.
§

impl From<Error> for DecompressBlockError

§

fn from(original: Error) -> DecompressBlockError

Converts to this type from the input type.
§

impl From<Error> for EncodingError

§

fn from(err: Error) -> EncodingError

Converts to this type from the input type.
§

impl From<Error> for EncodingError

§

fn from(source: Error) -> EncodingError

Converts to this type from the input type.
source§

impl From<Error> for Error

source§

fn from(err: Error) -> Error

Converts to this type from the input type.
source§

impl From<Error> for Error

source§

fn from(error: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(e: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(source: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(err: Error) -> Error

Converts to this type from the input type.
source§

impl From<Error> for Error

source§

fn from(j: Error) -> Error

Convert a serde_json::Error into an io::Error.

JSON syntax and data errors are turned into InvalidData I/O errors. EOF errors are turned into UnexpectedEof I/O errors.

use std::io;

enum MyError {
    Io(io::Error),
    Json(serde_json::Error),
}

impl From<serde_json::Error> for MyError {
    fn from(err: serde_json::Error) -> MyError {
        use serde_json::error::Category;
        match err.classify() {
            Category::Io => {
                MyError::Io(err.into())
            }
            Category::Syntax | Category::Data | Category::Eof => {
                MyError::Json(err)
            }
        }
    }
}
§

impl From<Error> for Error

§

fn from(source: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(err: Error) -> Error

Converts Calloop’s error type into a std::io::Error.

§

impl From<Error> for Error

§

fn from(val: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(err: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(walk_err: Error) -> Error

Convert the Error to an io::Error, preserving the original Error as the “inner error”. Note that this also makes the display of the error include the context.

This is different from into_io_error which returns the original io::Error.

source§

impl From<Error> for Error

source§

fn from(e: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(err: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(e: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

Enable using the ? operator on std::io::Result.

§

fn from(error: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(err: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for Error

§

fn from(e: Error) -> Error

Converts to this type from the input type.
§

impl From<Error> for ExrTextureLoaderError

§

fn from(source: Error) -> ExrTextureLoaderError

Converts to this type from the input type.
§

impl From<Error> for FontLoaderError

§

fn from(source: Error) -> FontLoaderError

Converts to this type from the input type.
§

impl From<Error> for GltfError

§

fn from(source: Error) -> GltfError

Converts to this type from the input type.
§

impl From<Error> for HdrTextureLoaderError

§

fn from(source: Error) -> HdrTextureLoaderError

Converts to this type from the input type.
§

impl From<Error> for ImageError

§

fn from(err: Error) -> ImageError

Converts to this type from the input type.
§

impl From<Error> for ImageLoaderError

§

fn from(source: Error) -> ImageLoaderError

Converts to this type from the input type.
§

impl From<Error> for MeshletMeshSaveOrLoadError

§

fn from(source: Error) -> MeshletMeshSaveOrLoadError

Converts to this type from the input type.
§

impl From<Error> for ReadLogError

§

fn from(source: Error) -> ReadLogError

Converts to this type from the input type.
§

impl From<Error> for ReplyError

§

fn from(err: Error) -> ReplyError

Converts to this type from the input type.
§

impl From<Error> for SceneLoaderError

§

fn from(source: Error) -> SceneLoaderError

Converts to this type from the input type.
§

impl From<Error> for ShaderLoaderError

§

fn from(source: Error) -> ShaderLoaderError

Converts to this type from the input type.
source§

impl From<Error> for SpannedError

source§

fn from(e: Error) -> SpannedError

Converts to this type from the input type.
§

impl From<Error> for WaylandError

§

fn from(err: Error) -> WaylandError

Converts to this type from the input type.
1.14.0 · source§

impl From<ErrorKind> for Error

Intended for use for errors not exposed to the user, where allocating onto the heap (for normal construction via Error::new) is too costly.

source§

fn from(kind: ErrorKind) -> Error

Converts an ErrorKind into an Error.

This conversion creates a new error with a simple representation of error kind.

§Examples
use std::io::{Error, ErrorKind};

let not_found = ErrorKind::NotFound;
let error = Error::from(not_found);
assert_eq!("entity not found", format!("{error}"));
1.0.0 · source§

impl<W> From<IntoInnerError<W>> for Error

source§

fn from(iie: IntoInnerError<W>) -> Error

Converts to this type from the input type.
1.0.0 · source§

impl From<NulError> for Error

1.78.0 · source§

impl From<TryReserveError> for Error

source§

fn from(_: TryReserveError) -> Error

Converts TryReserveError to an error with ErrorKind::OutOfMemory.

TryReserveError won’t be available as the error source(), but this may change in the future.

§

impl TryFrom<Error> for Errno

§

type Error = Error

The type returned in the event of a conversion error.
§

fn try_from(ioerror: Error) -> Result<Errno, Error>

Performs the conversion.
§

impl TryFrom<Error> for Errno

§

type Error = Error

The type returned in the event of a conversion error.
§

fn try_from(ioerror: Error) -> Result<Errno, Error>

Performs the conversion.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl !RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl !UnwindSafe for Error

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
§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

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<E> InstrumentError for E
where TracedError<E>: From<E>,

§

type Instrumented = TracedError<E>

The type of the wrapped error after instrumentation
source§

fn in_current_span(self) -> <E as InstrumentError>::Instrumented

Instrument an Error by bundling it with a SpanTrace 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<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

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

§

type Output = T

Should always be Self
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

§

impl<T> ToSmolStr for T
where T: Display + ?Sized,

§

fn to_smolstr(&self) -> SmolStr

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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> ConditionalSend for T
where T: Send,

§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Settings for T
where T: 'static + Send + Sync,

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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