Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub media_type: MediaType,
    pub source: InputSource,
    pub output: Option<PathBuf>,
    pub num_threads: usize,
    pub color_depth: ColorDepth,
    pub ascii: Config,
    pub dither: Option<DitherOptions>,
    /* private fields */
}
Expand description

A fully validated, immutable configuration produced by ConfigBuilder::build.

Cheap to share across threads/tasks behind an Arc<Config> — build it once and reuse it for every file in a batch or every frame of a video.

Fields§

§media_type: MediaType§source: InputSource§output: Option<PathBuf>§num_threads: usize§color_depth: ColorDepth§ascii: Config§dither: Option<DitherOptions>

Dithering applied when rendering, in place of iascii’s own plain per-cell nearest-palette color rounding — see crate::dither. None (the default) means the usual undithered rendering.

Implementations§

Source§

impl Config

Source

pub fn builder(media_type: MediaType) -> ConfigBuilder

Starts building a new configuration for the given media type.

Source

pub fn thread_pool(&self) -> Result<&Arc<ThreadPool>, ConfigError>

Returns the Rayon thread pool for this Config, building it on first use and reusing it for every subsequent call. Sized from Config::num_threads (0 means Rayon’s own default).

Call sites that used to build a fresh ThreadPool per file/frame (image batches, async single-image rendering, video streaming) should call this instead so the pool — and its worker OS threads — is created once per Config and shared.

Source

pub fn files(&self) -> Result<Vec<PathBuf>, ConfigError>

Resolves InputSource into the concrete list of files to process, sorted for deterministic ordering across parallel batch runs.

Trait Implementations§

Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Config

§

impl !RefUnwindSafe for Config

§

impl !UnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.