Capabilities

Struct Capabilities 

Source
#[non_exhaustive]
pub struct Capabilities { /* private fields */ }
Expand description

The detected current terminal capabilities.

It can be generated from Notcurses.capabilities().

Implementations§

Source§

impl Capabilities

Source

pub fn new(nc: &Notcurses) -> Self

New Capabilities from a Notcurses context.

Source

pub fn best_blitter(&self) -> Blitter

Returns the best Blitter available, using the following rules of graceful degradation:

Pixel > Sextant > Quadrant > Half > Ascii.

Source

pub fn can_blitter(&self, blitter: Blitter) -> bool

Returns true if the provided Blitter is among the capabilities.

Source

pub fn halfblock(&self) -> bool

Returns true if we can reliably use Unicode half blocks.

Source

pub fn quadrant(&self) -> bool

Returns true if we can reliably use Unicode quadrant blocks.

Source

pub fn sextant(&self) -> bool

Returns true if we can reliably use Unicode sextant blocks.

Source

pub fn braille(&self) -> bool

Returns true if we can reliably use Unicode Braille.

Source

pub fn utf8(&self) -> bool

Returns true if the encoding is UTF-8.

Source

pub fn images(&self) -> bool

Returns true if loading images is possible.

This requires that notcurse is built against FFmpeg/OIIO.

Source

pub fn videos(&self) -> bool

Returns true if loading videos is possible.

This requires that notcurse is built against FFmpeg/OIIO.

Source

pub fn pixel(&self) -> bool

Returns true if we can blit pixel-accurate bitmaps.

Source

pub const fn pixel_implementation(&self) -> PixelImplementation

Returns the detected pixel-blitting implementation.

Source

pub fn fade(&self) -> bool

Returns true if fading is possible.

Source

pub fn truecolor(&self) -> bool

Returns true if it’s possible to directly specify RGB values per Cell, or false if it’s only possible to use palettes.

Source

pub fn palette_change(&self) -> bool

Returns true if the “hardware” palette can be changed.

Requires the “ccc” terminfo capability, and that the number of colors supported is at least the size of the Palette structure.

Source

pub fn palette_size(&self) -> u32

Returns the number of simultaneous colors claimed to be supported, if there is color support.

Note that several terminal emulators advertise more colors than they actually support, downsampling internally.

Trait Implementations§

Source§

impl Clone for Capabilities

Source§

fn clone(&self) -> Capabilities

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 Capabilities

Source§

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

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

impl Display for Capabilities

Source§

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

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

impl PartialEq for Capabilities

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Capabilities

Source§

impl Eq for Capabilities

Source§

impl StructuralPartialEq for Capabilities

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.