Skip to main content

TakeBytes

Struct TakeBytes 

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

A source of bytes from either stdin or a file path.

TakeBytes implements FromStr, making it easy to use with clap’s derive API. When parsing:

  • "-" is interpreted as stdin
  • Any other string is treated as a file path

§Example

use clap::Parser;
use take_bytes::TakeBytes;

#[derive(Parser)]
struct Cli {
    /// Input file or "-" for stdin
    #[arg(default_value = "-")]
    input: TakeBytes,
}

§Programmatic Construction

use take_bytes::TakeBytes;

// Read from stdin
let stdin_input = TakeBytes::stdin();

// Read from a file (note: file must exist when calling from_str)
// let file_input = TakeBytes::file("/path/to/file");

Implementations§

Source§

impl TakeBytes

Source

pub fn stdin() -> Self

Create a TakeBytes that reads from stdin.

§Example
use take_bytes::TakeBytes;

let input = TakeBytes::stdin();
Source

pub fn file(path: PathBuf) -> Self

Create a TakeBytes that reads from a file.

Note: This does not check if the file exists. The check happens when you call try_into_bytes.

§Example
use take_bytes::TakeBytes;
use std::path::PathBuf;

let input = TakeBytes::file(PathBuf::from("/path/to/file"));
Source

pub fn try_into_bytes(self) -> Result<Vec<u8>, Error>

Read the entire contents from the input source, returning as bytes.

§Errors

Returns an error if:

  • The file cannot be opened (for file sources)
  • Reading from the source fails
§Example
use take_bytes::TakeBytes;

let input: TakeBytes = "-".parse()?;
let bytes = input.try_into_bytes()?;

Trait Implementations§

Source§

impl Clone for TakeBytes

Source§

fn clone(&self) -> TakeBytes

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 TakeBytes

Source§

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

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

impl FromStr for TakeBytes

Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a string into a TakeBytes.

  • "-" is interpreted as stdin
  • Any other string is treated as a file path
§Errors

Returns io::ErrorKind::NotFound if the path does not exist.

Source§

type Err = Error

The associated error which can be returned from parsing.

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> 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> 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.