Struct viuer::Config

source · [−]

pub struct Config {
    pub transparent: bool,
    pub absolute_offset: bool,
    pub x: u16,
    pub y: i16,
    pub restore_cursor: bool,
    pub width: Option<u32>,
    pub height: Option<u32>,
    pub truecolor: bool,
    pub use_kitty: bool,
    pub use_iterm: bool,
}

Expand description

Configuration struct to customize printing behaviour.

Fields

transparent: bool

Enable true transparency instead of checkerboard background. Available only for the block printer. Defaults to false.

absolute_offset: bool

Make the x and y offset be relative to the top left terminal corner. If false, the y offset is relative to the cursor’s position. Defaults to true.

x: u16

X offset. Defaults to 0.

y: i16

Y offset. Can be negative only when absolute_offset is false. Defaults to 0.

restore_cursor: bool

Take a note of cursor position before printing and restore it when finished. Defaults to false.

width: Option<u32>

Optional image width. Defaults to None.

height: Option<u32>

Optional image height. Defaults to None.

truecolor: bool

Use truecolor if the terminal supports it. Defaults to true.

use_kitty: bool

Use Kitty protocol if the terminal supports it. Defaults to true.

use_iterm: bool

Use iTerm protocol if the terminal supports it. Defaults to true.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian<P>,
P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.