scouter_sql::sql::postgres

Struct PostgresClient

Source 
pub struct PostgresClient {}

Implementations§

Source§

impl PostgresClient

Source

pub async fn create_db_pool( database_settings: &DatabaseSettings, ) -> Result<Pool<Postgres>, SqlError>

Setup the application with the given database pool.

§Returns
  • Result<Pool<Postgres>, anyhow::Error> - Result of the database pool
Source

pub async fn run_migrations(pool: &Pool<Postgres>) -> Result<(), SqlError>

Trait Implementations§

Source§

impl AlertSqlLogic for PostgresClient

Source§

fn insert_drift_alert<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( pool: &'life0 Pool<Postgres>, task_info: &'life1 DriftTaskInfo, entity_name: &'life2 str, alert: &'life3 BTreeMap<String, String>, drift_type: &'life4 DriftType, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Inserts a drift alert into the database Read more
Source§

fn get_drift_alerts<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftAlertRequest, ) -> Pin<Box<dyn Future<Output = Result<Vec<Alert>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Get drift alerts from the database Read more
Source§

fn update_drift_alert_status<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 UpdateAlertStatus, ) -> Pin<Box<dyn Future<Output = Result<UpdateAlertResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Source§

impl ArchiveSqlLogic for PostgresClient

Source§

fn get_entities_to_archive<'life0, 'life1, 'life2, 'async_trait>( pool: &'life0 Pool<Postgres>, record_type: &'life1 RecordType, retention_period: &'life2 i32, ) -> Pin<Box<dyn Future<Output = Result<Vec<Entity>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Function to get entities for archival Read more
Source§

fn get_data_to_archive<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'life6, 'async_trait>( space: &'life0 str, name: &'life1 str, version: &'life2 str, begin_timestamp: &'life3 DateTime<Utc>, end_timestamp: &'life4 DateTime<Utc>, record_type: &'life5 RecordType, db_pool: &'life6 Pool<Postgres>, ) -> Pin<Box<dyn Future<Output = Result<ServerRecords, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, 'life6: 'async_trait,

Function to get data for archival Read more
Source§

fn update_data_to_archived<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'life6, 'async_trait>( space: &'life0 str, name: &'life1 str, version: &'life2 str, begin_timestamp: &'life3 DateTime<Utc>, end_timestamp: &'life4 DateTime<Utc>, record_type: &'life5 RecordType, db_pool: &'life6 Pool<Postgres>, ) -> Pin<Box<dyn Future<Output = Result<(), SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, 'life6: 'async_trait,

Source§

impl Clone for PostgresClient

Source§

fn clone(&self) -> PostgresClient

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 CustomMetricSqlLogic for PostgresClient

Source§

fn insert_custom_metric_value<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, record: &'life1 CustomMetricServerRecord, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Inserts a custom metric value into the database.
Source§

fn get_custom_metric_values<'life0, 'life1, 'life2, 'life3, 'async_trait>( pool: &'life0 Pool<Postgres>, service_info: &'life1 ServiceInfo, limit_datetime: &'life2 DateTime<Utc>, metrics: &'life3 [String], ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, f64>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Source§

fn get_records<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftRequest, minutes: i32, ) -> Pin<Box<dyn Future<Output = Result<BinnedCustomMetrics, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

and aggregation. Read more
Source§

fn merge_feature_results( results: BinnedCustomMetrics, map: &mut BinnedCustomMetrics, ) -> Result<(), SqlError>

Helper for merging custom drift records
Source§

fn get_archived_records<'life0, 'life1, 'async_trait>( params: &'life0 DriftRequest, begin: DateTime<Utc>, end: DateTime<Utc>, minutes: i32, storage_settings: &'life1 ObjectStorageSettings, ) -> Pin<Box<dyn Future<Output = Result<BinnedCustomMetrics, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

DataFusion implementation for getting custom drift records from archived data. Read more
Source§

fn get_binned_custom_drift_records<'life0, 'life1, 'life2, 'life3, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftRequest, retention_period: &'life2 i32, storage_settings: &'life3 ObjectStorageSettings, ) -> Pin<Box<dyn Future<Output = Result<BinnedCustomMetrics, SqlError>> + Send + 'async_trait>>
where Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Source§

impl Debug for PostgresClient

Source§

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

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

impl ObservabilitySqlLogic for PostgresClient

Source§

fn insert_observability_record<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, record: &'life1 ObservabilityMetrics, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_binned_observability_metrics<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 ObservabilityMetricRequest, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObservabilityResult>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Source§

impl ProfileSqlLogic for PostgresClient

Source§

fn insert_drift_profile<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, drift_profile: &'life1 DriftProfile, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Insert a drift profile into the database Read more
Source§

fn update_drift_profile<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, drift_profile: &'life1 DriftProfile, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Update a drift profile in the database Read more
Source§

fn get_drift_profile<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, request: &'life1 GetProfileRequest, ) -> Pin<Box<dyn Future<Output = Result<Option<Value>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Get a drift profile from the database Read more
Source§

fn get_drift_profile_task<'life0, 'async_trait>( pool: &'life0 Pool<Postgres>, ) -> Pin<Box<dyn Future<Output = Result<Option<TaskRequest>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait,

Source§

fn update_drift_profile_run_dates<'life0, 'life1, 'life2, 'async_trait>( pool: &'life0 Pool<Postgres>, task_info: &'life1 DriftTaskInfo, schedule: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Update the drift profile run dates in the database Read more
Source§

fn update_drift_profile_status<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 ProfileStatusRequest, ) -> Pin<Box<dyn Future<Output = Result<(), SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Source§

impl PsiSqlLogic for PostgresClient

Source§

fn insert_bin_counts<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, record: &'life1 PsiServerRecord, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Inserts a PSI bin count into the database. Read more
Source§

fn get_records<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftRequest, minutes: i32, ) -> Pin<Box<dyn Future<Output = Result<Vec<FeatureBinProportionResult>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Queries the database for PSI drift records based on a time window and aggregation. Read more
Source§

fn get_archived_records<'life0, 'life1, 'async_trait>( params: &'life0 DriftRequest, begin: DateTime<Utc>, end: DateTime<Utc>, minutes: i32, storage_settings: &'life1 ObjectStorageSettings, ) -> Pin<Box<dyn Future<Output = Result<Vec<FeatureBinProportionResult>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

DataFusion implementation for getting PSI drift records from archived data. Read more
Source§

fn merge_feature_results( results: Vec<FeatureBinProportionResult>, feature_map: &mut BTreeMap<String, FeatureBinProportionResult>, ) -> Result<(), SqlError>

Helper for merging current and archived binned PSI drift records.
Source§

fn get_binned_psi_drift_records<'life0, 'life1, 'life2, 'life3, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftRequest, retention_period: &'life2 i32, storage_settings: &'life3 ObjectStorageSettings, ) -> Pin<Box<dyn Future<Output = Result<Vec<FeatureBinProportionResult>, SqlError>> + Send + 'async_trait>>
where Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Source§

fn get_feature_distributions<'life0, 'life1, 'life2, 'life3, 'async_trait>( pool: &'life0 Pool<Postgres>, service_info: &'life1 ServiceInfo, limit_datetime: &'life2 DateTime<Utc>, features_to_monitor: &'life3 [String], ) -> Pin<Box<dyn Future<Output = Result<FeatureDistributions, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Source§

impl SpcSqlLogic for PostgresClient

Source§

fn insert_spc_drift_record<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, record: &'life1 SpcServerRecord, ) -> Pin<Box<dyn Future<Output = Result<PgQueryResult, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Inserts a drift record into the database Read more
Source§

fn get_spc_features<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, service_info: &'life1 ServiceInfo, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_spc_drift_records<'life0, 'life1, 'life2, 'life3, 'async_trait>( pool: &'life0 Pool<Postgres>, service_info: &'life1 ServiceInfo, limit_datetime: &'life2 DateTime<Utc>, features_to_monitor: &'life3 [String], ) -> Pin<Box<dyn Future<Output = Result<SpcDriftFeatures, SqlError>> + Send + 'async_trait>>
where Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Get SPC drift records Read more
Source§

fn get_records<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftRequest, minutes: i32, ) -> Pin<Box<dyn Future<Output = Result<SpcDriftFeatures, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Queries the database for SPC drift records based on a time window and aggregation. Read more
Source§

fn merge_feature_results( results: SpcDriftFeatures, map: &mut SpcDriftFeatures, ) -> Result<(), SqlError>

Helper for merging current and archived binned spc drift records.
Source§

fn get_archived_records<'life0, 'life1, 'async_trait>( params: &'life0 DriftRequest, begin: DateTime<Utc>, end: DateTime<Utc>, minutes: i32, storage_settings: &'life1 ObjectStorageSettings, ) -> Pin<Box<dyn Future<Output = Result<SpcDriftFeatures, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

DataFusion implementation for getting spc drift records from archived data. Read more
Source§

fn get_binned_spc_drift_records<'life0, 'life1, 'life2, 'life3, 'async_trait>( pool: &'life0 Pool<Postgres>, params: &'life1 DriftRequest, retention_period: &'life2 i32, storage_settings: &'life3 ObjectStorageSettings, ) -> Pin<Box<dyn Future<Output = Result<SpcDriftFeatures, SqlError>> + Send + 'async_trait>>
where Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Source§

impl UserSqlLogic for PostgresClient

Source§

fn insert_user<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, user: &'life1 User, ) -> Pin<Box<dyn Future<Output = Result<(), SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Inserts a new user into the database. Read more
Source§

fn get_user<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, username: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<User>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves a user from the database by username. Read more
Source§

fn update_user<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, user: &'life1 User, ) -> Pin<Box<dyn Future<Output = Result<(), SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Updates a user in the database. Read more
Source§

fn get_users<'life0, 'async_trait>( pool: &'life0 Pool<Postgres>, ) -> Pin<Box<dyn Future<Output = Result<Vec<User>, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait,

Retrieves all users from the database. Read more
Source§

fn is_last_admin<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, username: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Checks if user is the last admin in the system. Read more
Source§

fn delete_user<'life0, 'life1, 'async_trait>( pool: &'life0 Pool<Postgres>, username: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), SqlError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait,

Deletes a user from the database. Read more

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

Source§

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

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

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.

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> Paint for T
where T: ?Sized,

Source§

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();
Source§

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

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

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

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

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

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

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));
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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();
Source§

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

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

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

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

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

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

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));
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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();
Source§

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

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

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

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

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

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

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

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

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

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());
Source§

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

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

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

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

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

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

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

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

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

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();
Source§

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

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

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

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

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

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

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

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

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

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());
Source§

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

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

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

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

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

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

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

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

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

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);
Source§

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

Create a new Painted with a default Style. Read more
Source§

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Ungil for T
where T: Send,