Struct StatusFlags 

#[non_exhaustive]
pub struct StatusFlags(/* private fields */);

Printer status flags

Implementations

impl StatusFlags

pub const NOT_ERROR: Self

Printer not in error state

pub const SELECTED: Self

Printer selected

pub const PAPER_EMPTY: Self

Printer out of paper

impl StatusFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

Examples found in repository

examples/printer.rs (line 28)

const DEFAULT_STATUS: StatusFlags =
    StatusFlags::from_bits_truncate(StatusFlags::NOT_ERROR.bits() | StatusFlags::SELECTED.bits());

fn ioctl_read_printer_status(file: &File) -> Result<u8> {
    let getter = unsafe {
        ioctl::Getter::<{ opcode::read::<u8>(GADGET_IOC_MAGIC, GADGET_GET_PRINTER_STATUS) }, u8>::new()
    };
    Ok(unsafe { ioctl::ioctl(file, getter) }?)
}

fn ioctl_write_printer_status(file: &File, status: u8) -> Result<()> {
    let mut value = status;
    unsafe {
        ioctl::ioctl(
            file,
            ioctl::Updater::<{ opcode::read_write::<u8>(GADGET_IOC_MAGIC, GADGET_SET_PRINTER_STATUS) }, _>::new(
                &mut value,
            ),
        )
    }?;
    Ok(())
}

fn create_printer_gadget() -> Result<RegGadget> {
    usb_gadget::remove_all().expect("cannot remove all gadgets");

    let udc = default_udc().expect("cannot get UDC");
    let mut builder = Printer::builder();
    builder.pnp_string = Some("Rust PNP".to_string());

    let (_, func) = builder.build();
    let reg = Gadget::new(
        Class::INTERFACE_SPECIFIC,
        Id::LINUX_FOUNDATION_COMPOSITE,
        Strings::new("Clippy Manufacturer", "Rusty Printer", "RUST0123456"),
    )
    .with_config(Config::new("Config 1").with_function(func))
    .bind(&udc)?;

    Ok(reg)
}

fn read_printer_data(file: &mut File) -> Result<()> {
    let mut buf = [0u8; BUF_SIZE];
    let mut printed = 0;
    println!("Will exit after printing {} pages...", PRINT_EXIT_COUNT);

    loop {
        let bytes_read = match file.read(&mut buf) {
            Ok(bytes_read) if bytes_read > 0 => bytes_read,
            _ => break,
        };
        io::stdout().write_all(&buf[..bytes_read])?;
        io::stdout().flush()?;

        // check if %%EOF is in the buffer
        if buf.windows(5).any(|w| w == b"%%EOF") {
            printed += 1;
            if printed == PRINT_EXIT_COUNT {
                println!("Printed {} pages, exiting.", PRINT_EXIT_COUNT);
                break;
            }
        }
    }

    Ok(())
}

fn set_printer_status(file: &File, flags: StatusFlags, clear: bool) -> Result<StatusFlags> {
    let mut status = get_printer_status(file)?;
    if clear {
        status.remove(flags);
    } else {
        status.insert(flags);
    }
    let bits = status.bits();
    log::debug!("Setting printer status: {:08b}", bits);
    ioctl_write_printer_status(file, bits)?;
    Ok(StatusFlags::from_bits_truncate(bits))
}

pub const fn from_bits(bits: u8) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

Examples found in repository

examples/printer.rs (line 28)

const DEFAULT_STATUS: StatusFlags =
    StatusFlags::from_bits_truncate(StatusFlags::NOT_ERROR.bits() | StatusFlags::SELECTED.bits());

fn ioctl_read_printer_status(file: &File) -> Result<u8> {
    let getter = unsafe {
        ioctl::Getter::<{ opcode::read::<u8>(GADGET_IOC_MAGIC, GADGET_GET_PRINTER_STATUS) }, u8>::new()
    };
    Ok(unsafe { ioctl::ioctl(file, getter) }?)
}

fn ioctl_write_printer_status(file: &File, status: u8) -> Result<()> {
    let mut value = status;
    unsafe {
        ioctl::ioctl(
            file,
            ioctl::Updater::<{ opcode::read_write::<u8>(GADGET_IOC_MAGIC, GADGET_SET_PRINTER_STATUS) }, _>::new(
                &mut value,
            ),
        )
    }?;
    Ok(())
}

fn create_printer_gadget() -> Result<RegGadget> {
    usb_gadget::remove_all().expect("cannot remove all gadgets");

    let udc = default_udc().expect("cannot get UDC");
    let mut builder = Printer::builder();
    builder.pnp_string = Some("Rust PNP".to_string());

    let (_, func) = builder.build();
    let reg = Gadget::new(
        Class::INTERFACE_SPECIFIC,
        Id::LINUX_FOUNDATION_COMPOSITE,
        Strings::new("Clippy Manufacturer", "Rusty Printer", "RUST0123456"),
    )
    .with_config(Config::new("Config 1").with_function(func))
    .bind(&udc)?;

    Ok(reg)
}

fn read_printer_data(file: &mut File) -> Result<()> {
    let mut buf = [0u8; BUF_SIZE];
    let mut printed = 0;
    println!("Will exit after printing {} pages...", PRINT_EXIT_COUNT);

    loop {
        let bytes_read = match file.read(&mut buf) {
            Ok(bytes_read) if bytes_read > 0 => bytes_read,
            _ => break,
        };
        io::stdout().write_all(&buf[..bytes_read])?;
        io::stdout().flush()?;

        // check if %%EOF is in the buffer
        if buf.windows(5).any(|w| w == b"%%EOF") {
            printed += 1;
            if printed == PRINT_EXIT_COUNT {
                println!("Printed {} pages, exiting.", PRINT_EXIT_COUNT);
                break;
            }
        }
    }

    Ok(())
}

fn set_printer_status(file: &File, flags: StatusFlags, clear: bool) -> Result<StatusFlags> {
    let mut status = get_printer_status(file)?;
    if clear {
        status.remove(flags);
    } else {
        status.insert(flags);
    }
    let bits = status.bits();
    log::debug!("Setting printer status: {:08b}", bits);
    ioctl_write_printer_status(file, bits)?;
    Ok(StatusFlags::from_bits_truncate(bits))
}

fn get_printer_status(file: &File) -> Result<StatusFlags> {
    let status = ioctl_read_printer_status(file)?;
    log::debug!("Got printer status: {:08b}", status);
    let status = StatusFlags::from_bits_truncate(status);
    Ok(status)
}

pub const fn from_bits_retain(bits: u8) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

Examples found in repository

examples/printer.rs (line 117)

fn print_status(status: StatusFlags) {
    println!("Printer status is:");
    if status.contains(StatusFlags::SELECTED) {
        println!("     Printer is Selected");
    } else {
        println!("     Printer is NOT Selected");
    }
    if status.contains(StatusFlags::PAPER_EMPTY) {
        println!("     Paper is Out");
    } else {
        println!("     Paper is Loaded");
    }
    if status.contains(StatusFlags::NOT_ERROR) {
        println!("     Printer OK");
    } else {
        println!("     Printer ERROR");
    }
}

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

Examples found in repository

examples/printer.rs (line 100)

fn set_printer_status(file: &File, flags: StatusFlags, clear: bool) -> Result<StatusFlags> {
    let mut status = get_printer_status(file)?;
    if clear {
        status.remove(flags);
    } else {
        status.insert(flags);
    }
    let bits = status.bits();
    log::debug!("Setting printer status: {:08b}", bits);
    ioctl_write_printer_status(file, bits)?;
    Ok(StatusFlags::from_bits_truncate(bits))
}

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

Examples found in repository

examples/printer.rs (line 98)

fn set_printer_status(file: &File, flags: StatusFlags, clear: bool) -> Result<StatusFlags> {
    let mut status = get_printer_status(file)?;
    if clear {
        status.remove(flags);
    } else {
        status.insert(flags);
    }
    let bits = status.bits();
    log::debug!("Setting printer status: {:08b}", bits);
    ioctl_write_printer_status(file, bits)?;
    Ok(StatusFlags::from_bits_truncate(bits))
}

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl StatusFlags

pub const fn iter(&self) -> Iter<StatusFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<StatusFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for StatusFlags

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

Formats the value using the given formatter.

impl BitAnd for StatusFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = StatusFlags

The resulting type after applying the & operator.

impl BitAndAssign for StatusFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for StatusFlags

fn bitor(self, other: StatusFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = StatusFlags

The resulting type after applying the | operator.

impl BitOrAssign for StatusFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for StatusFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = StatusFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for StatusFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for StatusFlags

fn clone(&self) -> StatusFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusFlags

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

Formats the value using the given formatter.

impl Extend<StatusFlags> for StatusFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for StatusFlags

const FLAGS: &'static [Flag<StatusFlags>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> StatusFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<StatusFlags> for StatusFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for StatusFlags

type Item = StatusFlags

The type of the elements being iterated over.

type IntoIter = Iter<StatusFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for StatusFlags

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

Formats the value using the given formatter.

impl Not for StatusFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = StatusFlags

The resulting type after applying the ! operator.

impl Octal for StatusFlags

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

Formats the value using the given formatter.

impl PublicFlags for StatusFlags

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for StatusFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = StatusFlags

The resulting type after applying the - operator.

impl SubAssign for StatusFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for StatusFlags

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

Formats the value using the given formatter.

impl Copy for StatusFlags