Struct Attribute

#[repr(transparent)]
pub struct Attribute(u8);

Defines the style a cga character including its background and foreground colors.

Tuple Fields

0: u8

Implementations

impl Attribute

const FG_BITS: usize = 4usize

const FG_OFFSET: usize = 0usize

const BG_BITS: usize = 3usize

const BG_OFFSET: usize = 4usize

const BLINK_BITS: usize = 1usize

const BLINK_OFFSET: usize = 7usize

pub const fn new() -> Self

Creates a new default initialized bitfield.

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

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

const fn fg(&self) -> Color

Foreground color of the character

Bits: 0..4

const fn with_fg_checked(self, value: Color) -> Result<Self, ()>

Foreground color of the character

Bits: 0..4

const fn with_fg(self, value: Color) -> Self

Foreground color of the character

Bits: 0..4

fn set_fg(&mut self, value: Color)

Foreground color of the character

Bits: 0..4

fn set_fg_checked(&mut self, value: Color) -> Result<(), ()>

Foreground color of the character

Bits: 0..4

const fn bg(&self) -> Color

Background color

Bits: 4..7

const fn with_bg_checked(self, value: Color) -> Result<Self, ()>

Background color

Bits: 4..7

const fn with_bg(self, value: Color) -> Self

Background color

Bits: 4..7

fn set_bg(&mut self, value: Color)

Background color

Bits: 4..7

fn set_bg_checked(&mut self, value: Color) -> Result<(), ()>

Background color

Bits: 4..7

const fn blink(&self) -> bool

If the character should blink (might not work in some cases)

Bits: 7..8

const fn with_blink_checked(self, value: bool) -> Result<Self, ()>

If the character should blink (might not work in some cases)

Bits: 7..8

const fn with_blink(self, value: bool) -> Self

If the character should blink (might not work in some cases)

Bits: 7..8

fn set_blink(&mut self, value: bool)

If the character should blink (might not work in some cases)

Bits: 7..8

fn set_blink_checked(&mut self, value: bool) -> Result<(), ()>

If the character should blink (might not work in some cases)

Bits: 7..8

impl Attribute

pub const fn with(fg: Color, bg: Color) -> Self

Construct an attribute with the given foreground and background colors.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Default for Attribute

fn default() -> Self

Returns the “default value” for a type.

impl From<Attribute> for u8

fn from(v: Attribute) -> u8

Converts to this type from the input type.

impl From<u8> for Attribute

fn from(v: u8) -> Self

Converts to this type from the input type.

impl Copy for Attribute