Enum clio::Input [−][src]
Expand description
An enum that represents a command line input stream, either std in or a file
Variants
Stdin(Stdin)
Implementations
impl Input
[src]
impl Input
[src]pub fn new<S: AsRef<OsStr>>(path: S) -> Result<Self>
[src]
pub fn new<S: AsRef<OsStr>>(path: S) -> Result<Self>
[src]Contructs a new input either by opening the file or for ‘-’ returning stdin
pub fn try_from_os_str(path: &OsStr) -> Result<Self, OsString>
[src]
pub fn try_from_os_str(path: &OsStr) -> Result<Self, OsString>
[src]Contructs a new input either by opening the file or for ‘-’ returning stdin The error is converted to a OsString so that stuctopt can show it to the user
pub fn len(&self) -> Option<u64>
[src]
pub fn len(&self) -> Option<u64>
[src]If input is a file, returns the size of the file, in bytes otherwise if input is stdin returns none.
Examples
let file = clio::Input::new("foo.txt").unwrap(); assert_eq!(Some(3), file.len());
pub fn is_empty(&self) -> Option<bool>
[src]
pub fn is_empty(&self) -> Option<bool>
[src]Returns a boolean saying if the file is empty, if using stdin returns None
Examples
let file = clio::Input::new("foo.txt").unwrap(); assert_eq!(Some(true), file.is_empty());
Trait Implementations
impl Read for Input
[src]
impl Read for Input
[src]fn read(&mut self, buf: &mut [u8]) -> IoResult<usize>
[src]
fn read(&mut self, buf: &mut [u8]) -> IoResult<usize>
[src]Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]Like read
, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool
[src]
fn is_read_vectored(&self) -> bool
[src]can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
[src]read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]Creates a “by reference” adaptor for this instance of Read
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Input
impl Send for Input
impl Sync for Input
impl Unpin for Input
impl UnwindSafe for Input
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more