Skip to main content

Task

Struct Task 

Source
pub struct Task {
    pub id: i64,
    pub service_id: i32,
    pub corpus_id: i32,
    pub status: i32,
    pub entry: String,
}
Expand description

A CorTeX task, for a given corpus-service pair

Fields§

§id: i64

task primary key, auto-incremented by postgresql

§service_id: i32

id of the service owning this task

§corpus_id: i32

id of the corpus hosting this task

§status: i32

current processing status of this task

§entry: String

entry path on the file system

Implementations§

Source§

impl Task

Source

pub fn delete_by_entry( &self, connection: &mut PgConnection, ) -> Result<usize, Error>

Delete task by entry

Source

pub fn delete_by_service_id( &self, connection: &mut PgConnection, ) -> Result<usize, Error>

Delete all tasks matching this task’s service id

Source

pub fn delete_by_id( &self, connection: &mut PgConnection, ) -> Result<usize, Error>

Delete task by id

Source

pub fn find(taskid: i64, connection: &mut PgConnection) -> Result<Task, Error>

Find task by id, error if none

Source

pub fn count_todo(connection: &mut PgConnection) -> i64

Count of TODO tasks for real conversion services — the pending-conversion backlog (work waiting to be dispatched to the fleet). The single operational “is the fleet keeping up?” number, shared by /metrics (cortex_tasks_todo), the admin dashboard, and cortex status. One count over tasks; bounded, and fast via the partial todo_index once a running dispatcher drains the backlog. 0 on a query error (best-effort, matching the report paths).

Excludes the magic infrastructure services (1=init, 2=import; real services are id > 2): their rows are status-0 (TODO) placeholders that exist for other services to activate over and never receive real conversion work, so counting them inflated the backlog with tasks that are never truly pending.

Source

pub fn find_by_entry( entry: &str, connection: &mut PgConnection, ) -> Result<Task, Error>

Find task by entry, error if none

Source

pub fn find_by_name( name: &str, corpus: &Corpus, service: &Service, connection: &mut PgConnection, ) -> Result<Task, Error>

Find task by name-suffix of an entry, error if none

Trait Implementations§

Source§

impl AsChangeset for Task

Source§

type Target = table

The table which Self::Changeset will be updating
Source§

type Changeset = <(Grouped<Eq<service_id, <i32 as AsExpression<<service_id as Expression>::SqlType>>::Expression>>, Grouped<Eq<corpus_id, <i32 as AsExpression<<corpus_id as Expression>::SqlType>>::Expression>>, Grouped<Eq<status, <i32 as AsExpression<<status as Expression>::SqlType>>::Expression>>, Grouped<Eq<entry, <String as AsExpression<<entry as Expression>::SqlType>>::Expression>>) as AsChangeset>::Changeset

The update statement this type represents
Source§

fn as_changeset(self) -> <Self as AsChangeset>::Changeset

Convert self into the actual update statement being executed
Source§

impl<'update> AsChangeset for &'update Task
where (Eq<service_id, &'update i32>, Eq<corpus_id, &'update i32>, Eq<status, &'update i32>, Eq<entry, &'update String>): AsChangeset,

Source§

type Target = table

The table which Self::Changeset will be updating
Source§

type Changeset = <(Grouped<Eq<service_id, <&'update i32 as AsExpression<<service_id as Expression>::SqlType>>::Expression>>, Grouped<Eq<corpus_id, <&'update i32 as AsExpression<<corpus_id as Expression>::SqlType>>::Expression>>, Grouped<Eq<status, <&'update i32 as AsExpression<<status as Expression>::SqlType>>::Expression>>, Grouped<Eq<entry, <&'update String as AsExpression<<entry as Expression>::SqlType>>::Expression>>) as AsChangeset>::Changeset

The update statement this type represents
Source§

fn as_changeset(self) -> <Self as AsChangeset>::Changeset

Convert self into the actual update statement being executed
Source§

impl<__FK> BelongsTo<&Corpus> for Task
where __FK: Hash + Eq, for<'__a> &'__a i32: Into<Option<&'__a __FK>>, for<'__a> &'__a Corpus: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = corpus_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<&Service> for Task
where __FK: Hash + Eq, for<'__a> &'__a i32: Into<Option<&'__a __FK>>, for<'__a> &'__a Service: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = service_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<&Task> for LogInfo
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<&Task> for LogWarning
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<&Task> for LogError
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<&Task> for LogFatal
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<&Task> for LogInvalid
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Corpus> for Task
where __FK: Hash + Eq, for<'__a> &'__a i32: Into<Option<&'__a __FK>>, for<'__a> &'__a Corpus: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = corpus_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Service> for Task
where __FK: Hash + Eq, for<'__a> &'__a i32: Into<Option<&'__a __FK>>, for<'__a> &'__a Service: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = service_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Task> for LogInfo
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Task> for LogWarning
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Task> for LogError
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Task> for LogFatal
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl<__FK> BelongsTo<Task> for LogInvalid
where __FK: Hash + Eq, for<'__a> &'__a i64: Into<Option<&'__a __FK>>, for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,

Source§

type ForeignKey = __FK

The foreign key of this struct
Source§

type ForeignKeyColumn = task_id

The database column representing the foreign key of the table this struct represents
Source§

fn foreign_key(&self) -> Option<&Self::ForeignKey>

Returns the foreign key for self
Source§

fn foreign_key_column() -> Self::ForeignKeyColumn

Returns the foreign key column of this struct’s table
Source§

impl Clone for Task

Source§

fn clone(&self) -> Task

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl CortexDeletable for Task

Source§

fn delete_by( &self, connection: &mut PgConnection, field: &str, ) -> Result<usize, Error>

Creates a new item given a connection
Source§

impl Debug for Task

Source§

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

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

impl Eq for Task

Source§

impl HasTable for Task

Source§

type Table = table

The table this type is associated with.
Source§

fn table() -> <Self as HasTable>::Table

Returns the table this type is associated with.
Source§

impl<'ident> Identifiable for &'ident Task

Source§

type Id = &'ident i64

The type of this struct’s identifier. Read more
Source§

fn id(self) -> <Self as Identifiable>::Id

Returns the identifier for this record. Read more
Source§

impl PartialEq for Task

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4), __DB> for Task
where (i64, i32, i32, i32, String): FromStaticSqlRow<(__ST0, __ST1, __ST2, __ST3, __ST4), __DB>,

Source§

type Row = (i64, i32, i32, i32, String)

The Rust type you’d like to map from. Read more
Source§

fn build(row: (i64, i32, i32, i32, String)) -> Result<Self>

Construct an instance of this type
Source§

impl<__DB: Backend> QueryableByName<__DB> for Task
where i64: FromSql<SqlTypeOf<id>, __DB>, i32: FromSql<SqlTypeOf<service_id>, __DB> + FromSql<SqlTypeOf<corpus_id>, __DB> + FromSql<SqlTypeOf<status>, __DB>, String: FromSql<SqlTypeOf<entry>, __DB>,

Source§

fn build<'__a>(row: &impl NamedRow<'__a, __DB>) -> Result<Self>

Construct an instance of Self from the database row
Source§

impl StructuralPartialEq for Task

Auto Trait Implementations§

§

impl Freeze for Task

§

impl RefUnwindSafe for Task

§

impl Send for Task

§

impl Sync for Task

§

impl Unpin for Task

§

impl UnsafeUnpin for Task

§

impl UnwindSafe for Task

Blanket Implementations§

§

impl<T> AggregateExpressionMethods for T

§

fn aggregate_distinct(self) -> Self::Output
where Self: DistinctDsl,

DISTINCT modifier for aggregate functions Read more
§

fn aggregate_all(self) -> Self::Output
where Self: AllDsl,

ALL modifier for aggregate functions Read more
§

fn aggregate_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

Add an aggregate function filter Read more
§

fn aggregate_order<O>(self, o: O) -> Self::Output
where Self: OrderAggregateDsl<O>,

Add an aggregate function order Read more
Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

§

impl<'a, Parent, Child> BelongingToDsl<&'a Vec<Parent>> for Child
where Child: BelongingToDsl<&'a [Parent]>,

§

type Output = <Child as BelongingToDsl<&'a [Parent]>>::Output

The query returned by belonging_to
§

fn belonging_to( parents: &'a Vec<Parent>, ) -> <Child as BelongingToDsl<&'a Vec<Parent>>>::Output

Get the record(s) belonging to record(s) other
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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compares self with key and returns true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<DB, T> FromSqlRow<Untyped, DB> for T
where DB: Backend, T: QueryableByName<DB>,

§

fn build_from_row<'a>( row: &impl Row<'a, DB>, ) -> Result<T, Box<dyn Error + Send + Sync>>

See the trait documentation.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

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
§

impl<T> IntoSql for T

§

fn into_sql<T>(self) -> Self::Expression
where Self: Sized + AsExpression<T>, T: SqlType + TypedExpressionType,

Convert self to an expression for Diesel’s query builder. Read more
§

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
where &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

Convert &self to an expression for Diesel’s query builder. Read more
§

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

§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling [Attribute] value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi [Quirk] value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1:

renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the [Condition] value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more
§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

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<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, ST, DB> StaticallySizedRow<ST, DB> for T
where ST: SqlTypeOrSelectable + TupleSize, T: Queryable<ST, DB>, DB: Backend,

§

const FIELD_COUNT: usize = <ST as crate::util::TupleSize>::SIZE

The number of fields that this type will consume.
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, 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WindowExpressionMethods for T

§

fn over(self) -> Self::Output
where Self: OverDsl,

Turn a function call into a window function call Read more
§

fn window_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

Add a filter to the current window function Read more
§

fn partition_by<E>(self, expr: E) -> Self::Output
where Self: PartitionByDsl<E>,

Add a partition clause to the current window function Read more
§

fn window_order<E>(self, expr: E) -> Self::Output
where Self: OrderWindowDsl<E>,

Add a order clause to the current window function Read more
§

fn frame_by<E>(self, expr: E) -> Self::Output
where Self: FrameDsl<E>,

Add a frame clause to the current window function Read more
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more