Error in core::io - Rust
Skip to main content Error core :: io Struct Error Source pub struct Error { /* private fields */ } 🔬 This is a nightly-only experimental API. ( core_io #154046 ) 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 1.0.0 · Source pub fn raw_os_error (&self) -> Option < RawOsError > 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.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::Error s, 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 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 Formats the value using the given formatter. Read more 1.0.0 · Source § impl Error for Error 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)> Returns the lower-level source of this error, if any.
Read more 1.0.0 · Source § fn description (&self) -> & str 👎 Deprecated since 1.42.0: use the Display impl or to_string() Read more Source § fn provide <'a>(&'a self, request: &mut Request <'a>) 🔬 This is a nightly-only experimental API. ( error_generic_member_access #99301 ) Provides type-based access to context intended for error reports. Read more 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}" )); Auto Trait Implementations § § impl ! RefUnwindSafe for Error § impl ! UnwindSafe for Error § impl Forget for Error § impl Freeze for Error § impl Move for Error § impl Send for Error § impl Sync for Error § impl Unpin for Error § impl UnsafeUnpin 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 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.
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, U> TryFrom <U> for T where U: Into <T>, Source § type Error = ! The type returned in the event of a conversion error. Source § fn try_from (value: U) -> Result <T, ! > 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.