InfluxDBv2ParametersBuilder

aws_sdk_timestreaminfluxdb::types::builders

Struct InfluxDBv2ParametersBuilder 

Source 
#[non_exhaustive]
pub struct InfluxDBv2ParametersBuilder { /* private fields */ }
Expand description

A builder for InfluxDBv2Parameters.

Implementations§

Source§

impl InfluxDBv2ParametersBuilder

Source

pub fn flux_log_enabled(self, input: bool) -> Self

Include option to show detailed logs for Flux queries.

Default: false

Source

pub fn set_flux_log_enabled(self, input: Option<bool>) -> Self

Include option to show detailed logs for Flux queries.

Default: false

Source

pub fn get_flux_log_enabled(&self) -> &Option<bool>

Include option to show detailed logs for Flux queries.

Default: false

Source

pub fn log_level(self, input: LogLevel) -> Self

Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

Default: info

Source

pub fn set_log_level(self, input: Option<LogLevel>) -> Self

Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

Default: info

Source

pub fn get_log_level(&self) -> &Option<LogLevel>

Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

Default: info

Source

pub fn no_tasks(self, input: bool) -> Self

Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

Default: false

Source

pub fn set_no_tasks(self, input: Option<bool>) -> Self

Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

Default: false

Source

pub fn get_no_tasks(&self) -> &Option<bool>

Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

Default: false

Source

pub fn query_concurrency(self, input: i32) -> Self

Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

Default: 0

Source

pub fn set_query_concurrency(self, input: Option<i32>) -> Self

Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

Default: 0

Source

pub fn get_query_concurrency(&self) -> &Option<i32>

Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

Default: 0

Source

pub fn query_queue_size(self, input: i32) -> Self

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Source

pub fn set_query_queue_size(self, input: Option<i32>) -> Self

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Source

pub fn get_query_queue_size(&self) -> &Option<i32>

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Source

pub fn tracing_type(self, input: TracingType) -> Self

Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

Source

pub fn set_tracing_type(self, input: Option<TracingType>) -> Self

Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

Source

pub fn get_tracing_type(&self) -> &Option<TracingType>

Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

Source

pub fn metrics_disabled(self, input: bool) -> Self

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

Default: false

Source

pub fn set_metrics_disabled(self, input: Option<bool>) -> Self

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

Default: false

Source

pub fn get_metrics_disabled(&self) -> &Option<bool>

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

Default: false

Source

pub fn http_idle_timeout(self, input: Duration) -> Self

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

Default: 3 minutes

Source

pub fn set_http_idle_timeout(self, input: Option<Duration>) -> Self

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

Default: 3 minutes

Source

pub fn get_http_idle_timeout(&self) -> &Option<Duration>

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

Default: 3 minutes

Source

pub fn http_read_header_timeout(self, input: Duration) -> Self

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

Default: 10 seconds

Source

pub fn set_http_read_header_timeout(self, input: Option<Duration>) -> Self

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

Default: 10 seconds

Source

pub fn get_http_read_header_timeout(&self) -> &Option<Duration>

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

Default: 10 seconds

Source

pub fn http_read_timeout(self, input: Duration) -> Self

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

Default: 0

Source

pub fn set_http_read_timeout(self, input: Option<Duration>) -> Self

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

Default: 0

Source

pub fn get_http_read_timeout(&self) -> &Option<Duration>

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

Default: 0

Source

pub fn http_write_timeout(self, input: Duration) -> Self

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

Default: 0

Source

pub fn set_http_write_timeout(self, input: Option<Duration>) -> Self

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

Default: 0

Source

pub fn get_http_write_timeout(&self) -> &Option<Duration>

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

Default: 0

Source

pub fn influxql_max_select_buckets(self, input: i64) -> Self

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

Default: 0

Source

pub fn set_influxql_max_select_buckets(self, input: Option<i64>) -> Self

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

Default: 0

Source

pub fn get_influxql_max_select_buckets(&self) -> &Option<i64>

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

Default: 0

Source

pub fn influxql_max_select_point(self, input: i64) -> Self

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

Default: 0

Source

pub fn set_influxql_max_select_point(self, input: Option<i64>) -> Self

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

Default: 0

Source

pub fn get_influxql_max_select_point(&self) -> &Option<i64>

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

Default: 0

Source

pub fn influxql_max_select_series(self, input: i64) -> Self

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

Default: 0

Source

pub fn set_influxql_max_select_series(self, input: Option<i64>) -> Self

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

Default: 0

Source

pub fn get_influxql_max_select_series(&self) -> &Option<i64>

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

Default: 0

Source

pub fn pprof_disabled(self, input: bool) -> Self

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

Default: true

Source

pub fn set_pprof_disabled(self, input: Option<bool>) -> Self

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

Default: true

Source

pub fn get_pprof_disabled(&self) -> &Option<bool>

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

Default: true

Source

pub fn query_initial_memory_bytes(self, input: i64) -> Self

Initial bytes of memory allocated for a query.

Default: 0

Source

pub fn set_query_initial_memory_bytes(self, input: Option<i64>) -> Self

Initial bytes of memory allocated for a query.

Default: 0

Source

pub fn get_query_initial_memory_bytes(&self) -> &Option<i64>

Initial bytes of memory allocated for a query.

Default: 0

Source

pub fn query_max_memory_bytes(self, input: i64) -> Self

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Source

pub fn set_query_max_memory_bytes(self, input: Option<i64>) -> Self

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Source

pub fn get_query_max_memory_bytes(&self) -> &Option<i64>

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Source

pub fn query_memory_bytes(self, input: i64) -> Self

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

Default: 0

Source

pub fn set_query_memory_bytes(self, input: Option<i64>) -> Self

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

Default: 0

Source

pub fn get_query_memory_bytes(&self) -> &Option<i64>

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

Default: 0

Source

pub fn session_length(self, input: i32) -> Self

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

Default: 60

Source

pub fn set_session_length(self, input: Option<i32>) -> Self

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

Default: 60

Source

pub fn get_session_length(&self) -> &Option<i32>

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

Default: 60

Source

pub fn session_renew_disabled(self, input: bool) -> Self

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

Default: false

Source

pub fn set_session_renew_disabled(self, input: Option<bool>) -> Self

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

Default: false

Source

pub fn get_session_renew_disabled(&self) -> &Option<bool>

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

Default: false

Source

pub fn storage_cache_max_memory_size(self, input: i64) -> Self

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

Default: 1073741824

Source

pub fn set_storage_cache_max_memory_size(self, input: Option<i64>) -> Self

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

Default: 1073741824

Source

pub fn get_storage_cache_max_memory_size(&self) -> &Option<i64>

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

Default: 1073741824

Source

pub fn storage_cache_snapshot_memory_size(self, input: i64) -> Self

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

Default: 26214400

Source

pub fn set_storage_cache_snapshot_memory_size(self, input: Option<i64>) -> Self

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

Default: 26214400

Source

pub fn get_storage_cache_snapshot_memory_size(&self) -> &Option<i64>

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

Default: 26214400

Source

pub fn storage_cache_snapshot_write_cold_duration(self, input: Duration) -> Self

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

Default: 10 minutes

Source

pub fn set_storage_cache_snapshot_write_cold_duration( self, input: Option<Duration>, ) -> Self

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

Default: 10 minutes

Source

pub fn get_storage_cache_snapshot_write_cold_duration( &self, ) -> &Option<Duration>

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

Default: 10 minutes

Source

pub fn storage_compact_full_write_cold_duration(self, input: Duration) -> Self

Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

Default: 4 hours

Source

pub fn set_storage_compact_full_write_cold_duration( self, input: Option<Duration>, ) -> Self

Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

Default: 4 hours

Source

pub fn get_storage_compact_full_write_cold_duration(&self) -> &Option<Duration>

Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

Default: 4 hours

Source

pub fn storage_compact_throughput_burst(self, input: i64) -> Self

Rate limit (in bytes per second) that TSM compactions can write to disk.

Default: 50331648

Source

pub fn set_storage_compact_throughput_burst(self, input: Option<i64>) -> Self

Rate limit (in bytes per second) that TSM compactions can write to disk.

Default: 50331648

Source

pub fn get_storage_compact_throughput_burst(&self) -> &Option<i64>

Rate limit (in bytes per second) that TSM compactions can write to disk.

Default: 50331648

Source

pub fn storage_max_concurrent_compactions(self, input: i32) -> Self

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

Default: 0

Source

pub fn set_storage_max_concurrent_compactions(self, input: Option<i32>) -> Self

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

Default: 0

Source

pub fn get_storage_max_concurrent_compactions(&self) -> &Option<i32>

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

Default: 0

Source

pub fn storage_max_index_log_file_size(self, input: i64) -> Self

Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

Default: 1048576

Source

pub fn set_storage_max_index_log_file_size(self, input: Option<i64>) -> Self

Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

Default: 1048576

Source

pub fn get_storage_max_index_log_file_size(&self) -> &Option<i64>

Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

Default: 1048576

Source

pub fn storage_no_validate_field_size(self, input: bool) -> Self

Skip field size validation on incoming write requests.

Default: false

Source

pub fn set_storage_no_validate_field_size(self, input: Option<bool>) -> Self

Skip field size validation on incoming write requests.

Default: false

Source

pub fn get_storage_no_validate_field_size(&self) -> &Option<bool>

Skip field size validation on incoming write requests.

Default: false

Source

pub fn storage_retention_check_interval(self, input: Duration) -> Self

Interval of retention policy enforcement checks. Must be greater than 0.

Default: 30 minutes

Source

pub fn set_storage_retention_check_interval( self, input: Option<Duration>, ) -> Self

Interval of retention policy enforcement checks. Must be greater than 0.

Default: 30 minutes

Source

pub fn get_storage_retention_check_interval(&self) -> &Option<Duration>

Interval of retention policy enforcement checks. Must be greater than 0.

Default: 30 minutes

Source

pub fn storage_series_file_max_concurrent_snapshot_compactions( self, input: i32, ) -> Self

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

Default: 0

Source

pub fn set_storage_series_file_max_concurrent_snapshot_compactions( self, input: Option<i32>, ) -> Self

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

Default: 0

Source

pub fn get_storage_series_file_max_concurrent_snapshot_compactions( &self, ) -> &Option<i32>

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

Default: 0

Source

pub fn storage_series_id_set_cache_size(self, input: i64) -> Self

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

Default: 100

Source

pub fn set_storage_series_id_set_cache_size(self, input: Option<i64>) -> Self

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

Default: 100

Source

pub fn get_storage_series_id_set_cache_size(&self) -> &Option<i64>

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

Default: 100

Source

pub fn storage_wal_max_concurrent_writes(self, input: i32) -> Self

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

Default: 0

Source

pub fn set_storage_wal_max_concurrent_writes(self, input: Option<i32>) -> Self

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

Default: 0

Source

pub fn get_storage_wal_max_concurrent_writes(&self) -> &Option<i32>

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

Default: 0

Source

pub fn storage_wal_max_write_delay(self, input: Duration) -> Self

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

Default: 10 minutes

Source

pub fn set_storage_wal_max_write_delay(self, input: Option<Duration>) -> Self

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

Default: 10 minutes

Source

pub fn get_storage_wal_max_write_delay(&self) -> &Option<Duration>

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

Default: 10 minutes

Source

pub fn ui_disabled(self, input: bool) -> Self

Disable the InfluxDB user interface (UI). The UI is enabled by default.

Default: false

Source

pub fn set_ui_disabled(self, input: Option<bool>) -> Self

Disable the InfluxDB user interface (UI). The UI is enabled by default.

Default: false

Source

pub fn get_ui_disabled(&self) -> &Option<bool>

Disable the InfluxDB user interface (UI). The UI is enabled by default.

Default: false

Source

pub fn build(self) -> InfluxDBv2Parameters

Consumes the builder and constructs a InfluxDBv2Parameters.

Trait Implementations§

Source§

impl Clone for InfluxDBv2ParametersBuilder

Source§

fn clone(&self) -> InfluxDBv2ParametersBuilder

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 Debug for InfluxDBv2ParametersBuilder

Source§

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

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

impl Default for InfluxDBv2ParametersBuilder

Source§

fn default() -> InfluxDBv2ParametersBuilder

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

impl PartialEq for InfluxDBv2ParametersBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 StructuralPartialEq for InfluxDBv2ParametersBuilder

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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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> Same for T

Source§

type Output = T

Should always be Self
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<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> ErasedDestructor for T
where T: 'static,