Struct floaout::format::bub::Bubble

pub struct Bubble {
    pub version: u8,
    pub bub_field_size: BubbleFieldSize,
    pub color: Color,
    pub blocks: u64,
    pub sampling_rate: u32,
    pub bits_per_sample: u16,
    pub name_size: u8,
    pub name: String,
    pub overall: BubbleField,
}

Details of the Bubble file.

Fields

version: u8

This is the number of Bubble version.

bub_field_size: BubbleFieldSize

This includes length, width and height.

color: Color

This includes red, green, blue.

blocks: u64

This is number of block.

sampling_rate: u32

Sampling Rate

bits_per_sample: u16

Bits Per Sample

name_size: u8

Bubble Name Size

name: String

Name of Bubble

overall: BubbleField

Overall of Bubble field

Methods

impl Bubble

pub fn from_bub_field_size_and_bits_per_sample(
    bub_field_size: BubbleFieldSize,
    bits_per_sample: u16
) -> Self

This method casts Bubble field size and bits per sample to Bubble.

Examples

use floaout::format::bub::Bubble;
 
let bub = Bubble::from_bub_field_size_and_bits_per_sample((0u8, 0u8, 0u8).into(), 32);
 
assert_eq!(
    bub,
    Bubble {
        bub_field_size: (0u8, 0u8, 0u8).into(),
        bits_per_sample: 32,
        ..Default::default()
    }
);

Trait Implementations

impl Clone for Bubble

fn clone(&self) -> Bubble

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bubble

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

Formats the value using the given formatter.

impl Default for Bubble

fn default() -> Bubble

Returns the "default value" for a type.

impl Eq for Bubble

impl From<Floaout> for Bubble

fn from(oao: Floaout) -> Self

Performs the conversion.

impl Hash for Bubble

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Bubble

fn cmp(&self, other: &Bubble) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Bubble> for Bubble

fn eq(&self, other: &Bubble) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Bubble) -> bool

This method tests for !=.

impl PartialOrd<Bubble> for Bubble

fn partial_cmp(&self, other: &Bubble) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Bubble) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Bubble) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Bubble) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Bubble) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'_, R: Read + ?Sized> ReadBlock<&'_ Bubble, BubbleBlock> for R

fn read_block(&mut self, bub: &Bubble) -> Result<BubbleBlock>

This method reads format block.

impl<R: Read + Seek> ReadFmt<Bubble, BubbleBlocks> for BufReader<R>

fn read_details(&mut self) -> Result<Bubble>

This method reads details of format.

fn read_blocks(&mut self, bub: &Bubble) -> Result<BubbleBlocks>

This method reads format blocks.

impl StructuralEq for Bubble

impl StructuralPartialEq for Bubble

impl TryFrom<Wav> for Bubble

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(wav: Wav) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<Wav> for Bubble

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Wav, Self::Error>

Performs the conversion.

impl<'_, '_, W: Write + ?Sized> WriteBlock<&'_ Bubble, &'_ BubbleBlock> for W

fn write_block(&mut self, bub: &Bubble, bub_block: &BubbleBlock) -> Result<()>

This method writes format block.

impl<W: Write> WriteFmt<Bubble, BubbleBlocks> for BufWriter<W>

fn write_details(&mut self, bub: &Bubble) -> Result<()>

This method writes details of format.

fn write_blocks(&mut self, bub: &Bubble, bub_blocks: BubbleBlocks) -> Result<()>

This method writes format block