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: i64task primary key, auto-incremented by postgresql
service_id: i32id of the service owning this task
corpus_id: i32id of the corpus hosting this task
status: i32current processing status of this task
entry: Stringentry path on the file system
Implementations§
Source§impl Task
impl Task
Sourcepub fn delete_by_entry(
&self,
connection: &mut PgConnection,
) -> Result<usize, Error>
pub fn delete_by_entry( &self, connection: &mut PgConnection, ) -> Result<usize, Error>
Delete task by entry
Sourcepub fn delete_by_service_id(
&self,
connection: &mut PgConnection,
) -> Result<usize, Error>
pub fn delete_by_service_id( &self, connection: &mut PgConnection, ) -> Result<usize, Error>
Delete all tasks matching this task’s service id
Sourcepub fn delete_by_id(
&self,
connection: &mut PgConnection,
) -> Result<usize, Error>
pub fn delete_by_id( &self, connection: &mut PgConnection, ) -> Result<usize, Error>
Delete task by id
Sourcepub fn find(taskid: i64, connection: &mut PgConnection) -> Result<Task, Error>
pub fn find(taskid: i64, connection: &mut PgConnection) -> Result<Task, Error>
Find task by id, error if none
Sourcepub fn count_todo(connection: &mut PgConnection) -> i64
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.
Sourcepub fn find_by_entry(
entry: &str,
connection: &mut PgConnection,
) -> Result<Task, Error>
pub fn find_by_entry( entry: &str, connection: &mut PgConnection, ) -> Result<Task, Error>
Find task by entry, error if none
Trait Implementations§
Source§impl AsChangeset for Task
impl AsChangeset for Task
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
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
Source§fn as_changeset(self) -> <Self as AsChangeset>::Changeset
fn as_changeset(self) -> <Self as AsChangeset>::Changeset
self into the actual update statement being executedSource§impl<'update> AsChangeset for &'update Task
impl<'update> AsChangeset for &'update Task
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
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
Source§fn as_changeset(self) -> <Self as AsChangeset>::Changeset
fn as_changeset(self) -> <Self as AsChangeset>::Changeset
self into the actual update statement being executedSource§impl<__FK> BelongsTo<&Corpus> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Corpus: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Corpus> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Corpus: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = corpus_id
type ForeignKeyColumn = corpus_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<&Service> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Service: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Service> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Service: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = service_id
type ForeignKeyColumn = service_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<&Task> for LogInfowhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Task> for LogInfowhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<&Task> for LogWarningwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Task> for LogWarningwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<&Task> for LogErrorwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Task> for LogErrorwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<&Task> for LogFatalwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Task> for LogFatalwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<&Task> for LogInvalidwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<&Task> for LogInvalidwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Corpus> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Corpus: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Corpus> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Corpus: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = corpus_id
type ForeignKeyColumn = corpus_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Service> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Service: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Service> for Taskwhere
__FK: Hash + Eq,
for<'__a> &'__a i32: Into<Option<&'__a __FK>>,
for<'__a> &'__a Service: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = service_id
type ForeignKeyColumn = service_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Task> for LogInfowhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Task> for LogInfowhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Task> for LogWarningwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Task> for LogWarningwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Task> for LogErrorwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Task> for LogErrorwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Task> for LogFatalwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Task> for LogFatalwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl<__FK> BelongsTo<Task> for LogInvalidwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
impl<__FK> BelongsTo<Task> for LogInvalidwhere
__FK: Hash + Eq,
for<'__a> &'__a i64: Into<Option<&'__a __FK>>,
for<'__a> &'__a Task: Identifiable<Id = &'__a __FK>,
Source§type ForeignKey = __FK
type ForeignKey = __FK
Source§type ForeignKeyColumn = task_id
type ForeignKeyColumn = task_id
Source§fn foreign_key(&self) -> Option<&Self::ForeignKey>
fn foreign_key(&self) -> Option<&Self::ForeignKey>
selfSource§fn foreign_key_column() -> Self::ForeignKeyColumn
fn foreign_key_column() -> Self::ForeignKeyColumn
Source§impl CortexDeletable for Task
impl CortexDeletable for Task
impl Eq for Task
Source§impl<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4), __DB> for Task
impl<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4), __DB> for Task
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
impl<T> AggregateExpressionMethods for T
§fn aggregate_distinct(self) -> Self::Outputwhere
Self: DistinctDsl,
fn aggregate_distinct(self) -> Self::Outputwhere
Self: DistinctDsl,
DISTINCT modifier for aggregate functions Read more§fn aggregate_all(self) -> Self::Outputwhere
Self: AllDsl,
fn aggregate_all(self) -> Self::Outputwhere
Self: AllDsl,
ALL modifier for aggregate functions Read more§fn aggregate_filter<P>(self, f: P) -> Self::Outputwhere
P: AsExpression<Bool>,
Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,
fn aggregate_filter<P>(self, f: P) -> Self::Outputwhere
P: AsExpression<Bool>,
Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,
§fn aggregate_order<O>(self, o: O) -> Self::Outputwhere
Self: OrderAggregateDsl<O>,
fn aggregate_order<O>(self, o: O) -> Self::Outputwhere
Self: OrderAggregateDsl<O>,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
§impl<'a, Parent, Child> BelongingToDsl<&'a Vec<Parent>> for Childwhere
Child: BelongingToDsl<&'a [Parent]>,
impl<'a, Parent, Child> BelongingToDsl<&'a Vec<Parent>> for Childwhere
Child: BelongingToDsl<&'a [Parent]>,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSend for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
self with key and returns true if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<DB, T> FromSqlRow<Untyped, DB> for Twhere
DB: Backend,
T: QueryableByName<DB>,
impl<DB, T> FromSqlRow<Untyped, DB> for Twhere
DB: Backend,
T: QueryableByName<DB>,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
§fn into_collection<A>(self) -> SmallVec<A>where
A: Array<Item = T>,
fn into_collection<A>(self) -> SmallVec<A>where
A: Array<Item = T>,
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
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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
impl<T> IntoSql for T
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§fn whenever(&self, value: Condition) -> Painted<&T>
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);