Struct tinybmp::Bmp

source · [−]

pub struct Bmp<'a, C> { /* private fields */ }

Expand description

A BMP-format bitmap

Implementations

source

impl<'a, C> Bmp<'a, C> where
C: PixelColor,

source

pub fn from_slice(bytes: &'a [u8 ]) -> Result<Self, ParseError>

Creates a bitmap object from a byte slice.

The created object keeps a shared reference to the input and does not dynamically allocate memory.

The color type must be explicitly specified when this method is called, for example by using the turbofish syntax. An error is returned if the bit depth of the specified color type doesn’t match the bit depth of the BMP file.

source

pub fn pixels<'b>(&'b self) -> Pixels<'b, 'a, C>ⓘNotable traits for Pixels<'_, '_, C>`impl<C> Iterator for Pixels<'_, '_, C> where C: PixelColor + From<<C as PixelColor>::Raw>, type Item = Pixel<C>;`

Returns an iterator over the pixels in this image.

source

pub fn as_raw(&self) -> &RawBmp<'a>

Returns a reference to the raw BMP image.

The RawBmp instance can be used to access lower level information about the BMP file.

Trait Implementations

source

impl<'a, C: Clone> Clone for Bmp<'a, C>

source

fn clone(&self) -> Bmp<'a, C>

Returns a copy 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<'a, C: Debug> Debug for Bmp<'a, C>

source

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

Formats the value using the given formatter. Read more

source

impl<'a, C: Hash> Hash for Bmp<'a, C>

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<C> ImageDrawable for Bmp<'_, C> where
C: PixelColor + From<<C as PixelColor>::Raw>,

type Color = C

The color type.

source

fn draw<D>(&self, target: &mut D) -> Result<(), D::Error> where
D: DrawTarget<Color = C>,

Draws the entire image to the target. Read more

source

fn draw_sub_image<D>(
 &self,
 target: &mut D,
 area: &Rectangle
) -> Result<(), D::Error> where
 D: DrawTarget<Color = Self::Color>,

Draws a part of the image to the target. Read more

source

impl<'a, C: Ord> Ord for Bmp<'a, C>

source

fn cmp(&self, other: &Bmp<'a, C>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl<C> OriginDimensions for Bmp<'_, C> where
C: PixelColor,

source

fn size(&self) -> Size

Returns the size of the bounding box.

source

impl<'a, C: PartialEq> PartialEq<Bmp<'a, C>> for Bmp<'a, C>

source

fn eq(&self, other: &Bmp<'a, C>) -> bool

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

source

fn ne(&self, other: &Bmp<'a, C>) -> bool

This method tests for !=.

source

impl<'a, C: PartialOrd> PartialOrd<Bmp<'a, C>> for Bmp<'a, C>

source

fn partial_cmp(&self, other: &Bmp<'a, C>) -> Option<Ordering>

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl<'a, C> StructuralPartialEq for Bmp<'a, C>

Auto Trait Implementations

impl<'a, C> RefUnwindSafe for Bmp<'a, C> where
C: RefUnwindSafe,

impl<'a, C> Send for Bmp<'a, C> where
C: Send,

impl<'a, C> Sync for Bmp<'a, C> where
C: Sync,

impl<'a, C> Unpin for Bmp<'a, C> where
C: Unpin,

impl<'a, C> UnwindSafe for Bmp<'a, C> where
C: UnwindSafe,

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> Az for T

source

fn az<Dst>(self) -> Dst where
T: Cast<Dst>,

Casts the value.

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Src, Dst> CastFrom<Src> for Dst where
Src: Cast<Dst>,

source

fn cast_from(src: Src) -> Dst

Casts the value.

source

impl<T> CheckedAs for T

source

fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,

Casts the value.

source

impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,

source

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> Dimensions for T where
T: OriginDimensions,

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> ImageDrawableExt for T where
T: ImageDrawable,

source

fn sub_image(&self, area: &Rectangle) -> SubImage<'_, T>

Returns a sub image of this image drawable. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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> OverflowingAs for T

source

fn overflowing_as<Dst>(self) -> (Dst, bool ) where
T: OverflowingCast<Dst>,

Casts the value.

source

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,

source

fn overflowing_cast_from(src: Src) -> (Dst, bool )

OverflowingCasts the value.

source

impl<T> SaturatingAs for T

source

fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,

Casts the value.

source

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,

source

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T> UnwrappedAs for T

source

fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,

Casts the value.

source

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,

source

fn unwrapped_cast_from(src: Src) -> Dst

UnwrappedCasts the value.

source

impl<T> WrappingAs for T

source

fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,

Casts the value.

source

impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,

source

fn wrapping_cast_from(src: Src) -> Dst

WrappingCasts the value.

Struct tinybmp::Bmp

Implementations

impl<'a, C> Bmp<'a, C> where C: PixelColor,

pub fn from_slice(bytes: &'a [u8]) -> Result<Self, ParseError>

pub fn pixels<'b>(&'b self) -> Pixels<'b, 'a, C>ⓘNotable traits for Pixels<'_, '_, C>impl<C> Iterator for Pixels<'_, '_, C> where C: PixelColor + From<<C as PixelColor>::Raw>, type Item = Pixel<C>;

pub fn as_raw(&self) -> &RawBmp<'a>

Trait Implementations

impl<'a, C: Clone> Clone for Bmp<'a, C>

fn clone(&self) -> Bmp<'a, C>

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

impl<'a, C: Debug> Debug for Bmp<'a, C>

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

impl<'a, C: Hash> Hash for Bmp<'a, C>

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

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

impl<C> ImageDrawable for Bmp<'_, C> where C: PixelColor + From<<C as PixelColor>::Raw>,

type Color = C

fn draw<D>(&self, target: &mut D) -> Result<(), D::Error> where D: DrawTarget<Color = C>,

fn draw_sub_image<D>( &self, target: &mut D, area: &Rectangle) -> Result<(), D::Error> where D: DrawTarget<Color = Self::Color>,

impl<'a, C: Ord> Ord for Bmp<'a, C>

fn cmp(&self, other: &Bmp<'a, C>) -> Ordering

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

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

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

impl<C> OriginDimensions for Bmp<'_, C> where C: PixelColor,

fn size(&self) -> Size

impl<'a, C: PartialEq> PartialEq<Bmp<'a, C>> for Bmp<'a, C>

fn eq(&self, other: &Bmp<'a, C>) -> bool

fn ne(&self, other: &Bmp<'a, C>) -> bool

impl<'a, C: PartialOrd> PartialOrd<Bmp<'a, C>> for Bmp<'a, C>

fn partial_cmp(&self, other: &Bmp<'a, C>) -> Option<Ordering>

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

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

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

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

impl<'a, C: Copy> Copy for Bmp<'a, C>

impl<'a, C: Eq> Eq for Bmp<'a, C>

impl<'a, C> StructuralEq for Bmp<'a, C>

impl<'a, C> StructuralPartialEq for Bmp<'a, C>

Auto Trait Implementations

impl<'a, C> RefUnwindSafe for Bmp<'a, C> where C: RefUnwindSafe,

impl<'a, C> Send for Bmp<'a, C> where C: Send,

impl<'a, C> Sync for Bmp<'a, C> where C: Sync,

impl<'a, C> Unpin for Bmp<'a, C> where C: Unpin,

impl<'a, C> UnwindSafe for Bmp<'a, C> where C: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Az for T

fn az<Dst>(self) -> Dst where T: Cast<Dst>,

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Src, Dst> CastFrom<Src> for Dst where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst> where T: CheckedCast<Dst>,

impl<Src, Dst> CheckedCastFrom<Src> for Dst where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

impl<T> Dimensions for T where T: OriginDimensions,

fn bounding_box(&self) -> Rectangle

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> ImageDrawableExt for T where T: ImageDrawable,

fn sub_image(&self, area: &Rectangle) -> SubImage<'_, T>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool) where T: OverflowingCast<Dst>,

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst where T: SaturatingCast<Dst>,

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

impl<'a, C> Bmp<'a, C> where
C: PixelColor,

pub fn from_slice(bytes: &'a [u8 ]) -> Result<Self, ParseError>

pub fn pixels<'b>(&'b self) -> Pixels<'b, 'a, C>ⓘNotable traits for Pixels<'_, '_, C>`impl<C> Iterator for Pixels<'_, '_, C> where C: PixelColor + From<<C as PixelColor>::Raw>, type Item = Pixel<C>;`

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

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

impl<C> ImageDrawable for Bmp<'_, C> where
C: PixelColor + From<<C as PixelColor>::Raw>,

fn draw<D>(&self, target: &mut D) -> Result<(), D::Error> where
D: DrawTarget<Color = C>,

fn draw_sub_image<D>(
&self,
target: &mut D,
area: &Rectangle
) -> Result<(), D::Error> where
D: DrawTarget<Color = Self::Color>,

impl<C> OriginDimensions for Bmp<'_, C> where
C: PixelColor,

impl<'a, C> RefUnwindSafe for Bmp<'a, C> where
C: RefUnwindSafe,

impl<'a, C> Send for Bmp<'a, C> where
C: Send,

impl<'a, C> Sync for Bmp<'a, C> where
C: Sync,

impl<'a, C> Unpin for Bmp<'a, C> where
C: Unpin,

impl<'a, C> UnwindSafe for Bmp<'a, C> where
C: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

fn az<Dst>(self) -> Dst where
T: Cast<Dst>,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Src, Dst> CastFrom<Src> for Dst where
Src: Cast<Dst>,

fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,

impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,

impl<T> Dimensions for T where
T: OriginDimensions,

impl<T> ImageDrawableExt for T where
T: ImageDrawable,

impl<T, U> Into<U> for T where
U: From<T>,

fn overflowing_as<Dst>(self) -> (Dst, bool ) where
T: OverflowingCast<Dst>,

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool )

fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,

fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,

impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,