FdReader

Struct FdReader 

Source
pub struct FdReader { /* private fields */ }
Expand description

Input function that reads from a file descriptor.

An instance of FdReader contains a SharedSystem to interact with the file descriptor.

Although FdReader implements Clone, it does not mean you can create and keep a copy of a FdReader instance to replay the input later. Since both the original and clone share the same SharedSystem, reading a line from one instance will affect the next read from the other.

Implementations§

Source§

impl FdReader

Source

pub fn new(fd: Fd, system: SharedSystem) -> Self

Creates a new FdReader instance.

The fd argument is the file descriptor to read from. It should be readable, have the close-on-exec flag set, and remain open for the lifetime of the FdReader instance.

Source

pub fn set_echo(&mut self, echo: Option<Rc<Cell<State>>>)

👎Deprecated: use Echo instead

Sets the “echo” flag.

You can use this setter function to set a shared option state that controls whether the input function echoes lines it reads to the standard error. If echo is None or some shared cell containing Off, the function does not echo. If a cell has On, the function prints every line it reads to the standard error.

This option implements the behavior of the verbose shell option. You can change the state of the shared cell through the lifetime of the input function to reflect the option dynamically changed, which will affect the next next_line call.

§Deprecation

This function is deprecated in favor of the Echo struct.

Trait Implementations§

Source§

impl Clone for FdReader

Source§

fn clone(&self) -> FdReader

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FdReader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Input for FdReader

Source§

async fn next_line(&mut self, _context: &Context) -> Result

Reads a next line of the source code. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InputObject for T
where T: Input,

Source§

fn next_line<'a>( &'a mut self, context: &'a Context, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + 'a>>

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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.