databend_common_ast::ast

Enum Statement

Source 
pub enum Statement {

Show 176 variants    Query(Box<Query>),
    StatementWithSettings {
        settings: Option<Settings>,
        stmt: Box<Statement>,
    },
    Explain {
        kind: ExplainKind,
        options: (Span, Vec<ExplainOption>),
        query: Box<Statement>,
    },
    ExplainAnalyze {
        partial: bool,
        graphical: bool,
        query: Box<Statement>,
    },
    ReportIssue(String),
    CopyIntoTable(CopyIntoTableStmt),
    CopyIntoLocation(CopyIntoLocationStmt),
    Call(CallStmt),
    ShowSettings {
        show_options: Option<ShowOptions>,
    },
    ShowProcessList {
        show_options: Option<ShowOptions>,
    },
    ShowMetrics {
        show_options: Option<ShowOptions>,
    },
    ShowEngines {
        show_options: Option<ShowOptions>,
    },
    ShowFunctions {
        show_options: Option<ShowOptions>,
    },
    ShowUserFunctions {
        show_options: Option<ShowOptions>,
    },
    ShowTableFunctions {
        show_options: Option<ShowOptions>,
    },
    ShowIndexes {
        show_options: Option<ShowOptions>,
    },
    ShowLocks(ShowLocksStmt),
    KillStmt {
        kill_target: KillTarget,
        object_id: String,
    },
    SetStmt {
        settings: Settings,
    },
    UnSetStmt {
        settings: Settings,
    },
    ShowVariables {
        show_options: Option<ShowOptions>,
    },
    SetRole {
        is_default: bool,
        role_name: String,
    },
    SetSecondaryRoles {
        option: SecondaryRolesOption,
    },
    Insert(InsertStmt),
    InsertMultiTable(InsertMultiTableStmt),
    Replace(ReplaceStmt),
    MergeInto(MergeIntoStmt),
    Delete(DeleteStmt),
    Update(UpdateStmt),
    ShowCatalogs(ShowCatalogsStmt),
    ShowCreateCatalog(ShowCreateCatalogStmt),
    CreateCatalog(CreateCatalogStmt),
    DropCatalog(DropCatalogStmt),
    UseCatalog {
        catalog: Identifier,
    },
    ShowOnlineNodes(ShowOnlineNodesStmt),
    UseWarehouse(UseWarehouseStmt),
    ShowWarehouses(ShowWarehousesStmt),
    DropWarehouse(DropWarehouseStmt),
    CreateWarehouse(CreateWarehouseStmt),
    RenameWarehouse(RenameWarehouseStmt),
    ResumeWarehouse(ResumeWarehouseStmt),
    SuspendWarehouse(SuspendWarehouseStmt),
    InspectWarehouse(InspectWarehouseStmt),
    AddWarehouseCluster(AddWarehouseClusterStmt),
    DropWarehouseCluster(DropWarehouseClusterStmt),
    RenameWarehouseCluster(RenameWarehouseClusterStmt),
    AssignWarehouseNodes(AssignWarehouseNodesStmt),
    UnassignWarehouseNodes(UnassignWarehouseNodesStmt),
    ShowWorkloadGroups(ShowWorkloadGroupsStmt),
    CreateWorkloadGroup(CreateWorkloadGroupStmt),
    DropWorkloadGroup(DropWorkloadGroupStmt),
    RenameWorkloadGroup(RenameWorkloadGroupStmt),
    SetWorkloadQuotasGroup(SetWorkloadGroupQuotasStmt),
    UnsetWorkloadQuotasGroup(UnsetWorkloadGroupQuotasStmt),
    ShowDatabases(ShowDatabasesStmt),
    ShowDropDatabases(ShowDropDatabasesStmt),
    ShowCreateDatabase(ShowCreateDatabaseStmt),
    CreateDatabase(CreateDatabaseStmt),
    DropDatabase(DropDatabaseStmt),
    UndropDatabase(UndropDatabaseStmt),
    AlterDatabase(AlterDatabaseStmt),
    UseDatabase {
        database: Identifier,
    },
    ShowTables(ShowTablesStmt),
    ShowCreateTable(ShowCreateTableStmt),
    DescribeTable(DescribeTableStmt),
    ShowTablesStatus(ShowTablesStatusStmt),
    ShowDropTables(ShowDropTablesStmt),
    AttachTable(AttachTableStmt),
    CreateTable(CreateTableStmt),
    DropTable(DropTableStmt),
    UndropTable(UndropTableStmt),
    AlterTable(AlterTableStmt),
    RenameTable(RenameTableStmt),
    TruncateTable(TruncateTableStmt),
    OptimizeTable(OptimizeTableStmt),
    VacuumTable(VacuumTableStmt),
    VacuumDropTable(VacuumDropTableStmt),
    VacuumTemporaryFiles(VacuumTemporaryFiles),
    AnalyzeTable(AnalyzeTableStmt),
    ExistsTable(ExistsTableStmt),
    CreateDictionary(CreateDictionaryStmt),
    DropDictionary(DropDictionaryStmt),
    ShowCreateDictionary(ShowCreateDictionaryStmt),
    ShowDictionaries(ShowDictionariesStmt),
    RenameDictionary(RenameDictionaryStmt),
    ShowColumns(ShowColumnsStmt),
    CreateView(CreateViewStmt),
    AlterView(AlterViewStmt),
    DropView(DropViewStmt),
    ShowViews(ShowViewsStmt),
    DescribeView(DescribeViewStmt),
    CreateStream(CreateStreamStmt),
    DropStream(DropStreamStmt),
    ShowStreams(ShowStreamsStmt),
    DescribeStream(DescribeStreamStmt),
    CreateIndex(CreateIndexStmt),
    DropIndex(DropIndexStmt),
    RefreshIndex(RefreshIndexStmt),
    CreateTableIndex(CreateTableIndexStmt),
    DropTableIndex(DropTableIndexStmt),
    RefreshTableIndex(RefreshTableIndexStmt),
    RefreshVirtualColumn(RefreshVirtualColumnStmt),
    ShowVirtualColumns(ShowVirtualColumnsStmt),
    ShowUsers {
        show_options: Option<ShowOptions>,
    },
    DescribeUser {
        user: UserIdentity,
    },
    CreateUser(CreateUserStmt),
    AlterUser(AlterUserStmt),
    DropUser {
        if_exists: bool,
        user: UserIdentity,
    },
    ShowRoles {
        show_options: Option<ShowOptions>,
    },
    CreateRole {
        if_not_exists: bool,
        role_name: String,
    },
    DropRole {
        if_exists: bool,
        role_name: String,
    },
    Grant(GrantStmt),
    ShowGrants {
        principal: Option<PrincipalIdentity>,
        show_options: Option<ShowOptions>,
    },
    ShowObjectPrivileges(ShowObjectPrivilegesStmt),
    ShowGrantsOfRole(ShowGranteesOfRoleStmt),
    Revoke(RevokeStmt),
    CreateUDF(CreateUDFStmt),
    DropUDF {
        if_exists: bool,
        udf_name: Identifier,
    },
    AlterUDF(AlterUDFStmt),
    CreateStage(CreateStageStmt),
    ShowStages {
        show_options: Option<ShowOptions>,
    },
    DropStage {
        if_exists: bool,
        stage_name: String,
    },
    DescribeStage {
        stage_name: String,
    },
    RemoveStage {
        location: String,
        pattern: String,
    },
    ListStage {
        location: String,
        pattern: Option<String>,
    },
    CreateConnection(CreateConnectionStmt),
    DropConnection(DropConnectionStmt),
    DescribeConnection(DescribeConnectionStmt),
    ShowConnections(ShowConnectionsStmt),
    CreateFileFormat {
        create_option: CreateOption,
        name: String,
        file_format_options: FileFormatOptions,
    },
    DropFileFormat {
        if_exists: bool,
        name: String,
    },
    ShowFileFormats,
    Presign(PresignStmt),
    CreateDatamaskPolicy(CreateDatamaskPolicyStmt),
    DropDatamaskPolicy(DropDatamaskPolicyStmt),
    DescDatamaskPolicy(DescDatamaskPolicyStmt),
    CreateNetworkPolicy(CreateNetworkPolicyStmt),
    AlterNetworkPolicy(AlterNetworkPolicyStmt),
    DropNetworkPolicy(DropNetworkPolicyStmt),
    DescNetworkPolicy(DescNetworkPolicyStmt),
    ShowNetworkPolicies,
    CreatePasswordPolicy(CreatePasswordPolicyStmt),
    AlterPasswordPolicy(AlterPasswordPolicyStmt),
    DropPasswordPolicy(DropPasswordPolicyStmt),
    DescPasswordPolicy(DescPasswordPolicyStmt),
    ShowPasswordPolicies {
        show_options: Option<ShowOptions>,
    },
    CreateTask(CreateTaskStmt),
    AlterTask(AlterTaskStmt),
    ExecuteTask(ExecuteTaskStmt),
    DescribeTask(DescribeTaskStmt),
    DropTask(DropTaskStmt),
    ShowTasks(ShowTasksStmt),
    CreateDynamicTable(CreateDynamicTableStmt),
    CreatePipe(CreatePipeStmt),
    DescribePipe(DescribePipeStmt),
    DropPipe(DropPipeStmt),
    AlterPipe(AlterPipeStmt),
    Begin,
    Commit,
    Abort,
    CreateNotification(CreateNotificationStmt),
    AlterNotification(AlterNotificationStmt),
    DropNotification(DropNotificationStmt),
    DescribeNotification(DescribeNotificationStmt),
    ExecuteImmediate(ExecuteImmediateStmt),
    CreateProcedure(CreateProcedureStmt),
    DropProcedure(DropProcedureStmt),
    ShowProcedures {
        show_options: Option<ShowOptions>,
    },
    DescProcedure(DescProcedureStmt),
    CallProcedure(CallProcedureStmt),
    CreateSequence(CreateSequenceStmt),
    DropSequence(DropSequenceStmt),
    ShowSequences {
        show_options: Option<ShowOptions>,
    },
    DescSequence {
        name: Identifier,
    },
    SetPriority {
        priority: Priority,
        object_id: String,
    },
    System(SystemStmt),

}

Variants§

§

Query(Box<Query>)

§

StatementWithSettings

Fields

§settings: Option<Settings>
§stmt: Box<Statement>
§

Explain

Fields

§kind: ExplainKind
§options: (Span, Vec<ExplainOption>)
§query: Box<Statement>
§

ExplainAnalyze

Fields

§partial: bool
§graphical: bool
§query: Box<Statement>
§

ReportIssue(String)

§

CopyIntoTable(CopyIntoTableStmt)

§

CopyIntoLocation(CopyIntoLocationStmt)

§

Call(CallStmt)

§

ShowSettings

Fields

§show_options: Option<ShowOptions>
§

ShowProcessList

Fields

§show_options: Option<ShowOptions>
§

ShowMetrics

Fields

§show_options: Option<ShowOptions>
§

ShowEngines

Fields

§show_options: Option<ShowOptions>
§

ShowFunctions

Fields

§show_options: Option<ShowOptions>
§

ShowUserFunctions

Fields

§show_options: Option<ShowOptions>
§

ShowTableFunctions

Fields

§show_options: Option<ShowOptions>
§

ShowIndexes

Fields

§show_options: Option<ShowOptions>
§

ShowLocks(ShowLocksStmt)

§

KillStmt

Fields

§kill_target: KillTarget
§object_id: String
§

SetStmt

Fields

§settings: Settings
§

UnSetStmt

Fields

§settings: Settings
§

ShowVariables

Fields

§show_options: Option<ShowOptions>
§

SetRole

Fields

§is_default: bool
§role_name: String
§

SetSecondaryRoles

§

Insert(InsertStmt)

§

InsertMultiTable(InsertMultiTableStmt)

§

Replace(ReplaceStmt)

§

MergeInto(MergeIntoStmt)

§

Delete(DeleteStmt)

§

Update(UpdateStmt)

§

ShowCatalogs(ShowCatalogsStmt)

§

ShowCreateCatalog(ShowCreateCatalogStmt)

§

CreateCatalog(CreateCatalogStmt)

§

DropCatalog(DropCatalogStmt)

§

UseCatalog

Fields

§catalog: Identifier
§

ShowOnlineNodes(ShowOnlineNodesStmt)

§

UseWarehouse(UseWarehouseStmt)

§

ShowWarehouses(ShowWarehousesStmt)

§

DropWarehouse(DropWarehouseStmt)

§

CreateWarehouse(CreateWarehouseStmt)

§

RenameWarehouse(RenameWarehouseStmt)

§

ResumeWarehouse(ResumeWarehouseStmt)

§

SuspendWarehouse(SuspendWarehouseStmt)

§

InspectWarehouse(InspectWarehouseStmt)

§

AddWarehouseCluster(AddWarehouseClusterStmt)

§

DropWarehouseCluster(DropWarehouseClusterStmt)

§

RenameWarehouseCluster(RenameWarehouseClusterStmt)

§

AssignWarehouseNodes(AssignWarehouseNodesStmt)

§

UnassignWarehouseNodes(UnassignWarehouseNodesStmt)

§

ShowWorkloadGroups(ShowWorkloadGroupsStmt)

§

CreateWorkloadGroup(CreateWorkloadGroupStmt)

§

DropWorkloadGroup(DropWorkloadGroupStmt)

§

RenameWorkloadGroup(RenameWorkloadGroupStmt)

§

SetWorkloadQuotasGroup(SetWorkloadGroupQuotasStmt)

§

UnsetWorkloadQuotasGroup(UnsetWorkloadGroupQuotasStmt)

§

ShowDatabases(ShowDatabasesStmt)

§

ShowDropDatabases(ShowDropDatabasesStmt)

§

ShowCreateDatabase(ShowCreateDatabaseStmt)

§

CreateDatabase(CreateDatabaseStmt)

§

DropDatabase(DropDatabaseStmt)

§

UndropDatabase(UndropDatabaseStmt)

§

AlterDatabase(AlterDatabaseStmt)

§

UseDatabase

Fields

§database: Identifier
§

ShowTables(ShowTablesStmt)

§

ShowCreateTable(ShowCreateTableStmt)

§

DescribeTable(DescribeTableStmt)

§

ShowTablesStatus(ShowTablesStatusStmt)

§

ShowDropTables(ShowDropTablesStmt)

§

AttachTable(AttachTableStmt)

§

CreateTable(CreateTableStmt)

§

DropTable(DropTableStmt)

§

UndropTable(UndropTableStmt)

§

AlterTable(AlterTableStmt)

§

RenameTable(RenameTableStmt)

§

TruncateTable(TruncateTableStmt)

§

OptimizeTable(OptimizeTableStmt)

§

VacuumTable(VacuumTableStmt)

§

VacuumDropTable(VacuumDropTableStmt)

§

VacuumTemporaryFiles(VacuumTemporaryFiles)

§

AnalyzeTable(AnalyzeTableStmt)

§

ExistsTable(ExistsTableStmt)

§

CreateDictionary(CreateDictionaryStmt)

§

DropDictionary(DropDictionaryStmt)

§

ShowCreateDictionary(ShowCreateDictionaryStmt)

§

ShowDictionaries(ShowDictionariesStmt)

§

RenameDictionary(RenameDictionaryStmt)

§

ShowColumns(ShowColumnsStmt)

§

CreateView(CreateViewStmt)

§

AlterView(AlterViewStmt)

§

DropView(DropViewStmt)

§

ShowViews(ShowViewsStmt)

§

DescribeView(DescribeViewStmt)

§

CreateStream(CreateStreamStmt)

§

DropStream(DropStreamStmt)

§

ShowStreams(ShowStreamsStmt)

§

DescribeStream(DescribeStreamStmt)

§

CreateIndex(CreateIndexStmt)

§

DropIndex(DropIndexStmt)

§

RefreshIndex(RefreshIndexStmt)

§

CreateTableIndex(CreateTableIndexStmt)

§

DropTableIndex(DropTableIndexStmt)

§

RefreshTableIndex(RefreshTableIndexStmt)

§

RefreshVirtualColumn(RefreshVirtualColumnStmt)

§

ShowVirtualColumns(ShowVirtualColumnsStmt)

§

ShowUsers

Fields

§show_options: Option<ShowOptions>
§

DescribeUser

Fields

§user: UserIdentity
§

CreateUser(CreateUserStmt)

§

AlterUser(AlterUserStmt)

§

DropUser

Fields

§if_exists: bool
§user: UserIdentity
§

ShowRoles

Fields

§show_options: Option<ShowOptions>
§

CreateRole

Fields

§if_not_exists: bool
§role_name: String
§

DropRole

Fields

§if_exists: bool
§role_name: String
§

Grant(GrantStmt)

§

ShowGrants

Fields

§principal: Option<PrincipalIdentity>
§show_options: Option<ShowOptions>
§

ShowObjectPrivileges(ShowObjectPrivilegesStmt)

§

ShowGrantsOfRole(ShowGranteesOfRoleStmt)

§

Revoke(RevokeStmt)

§

CreateUDF(CreateUDFStmt)

§

DropUDF

Fields

§if_exists: bool
§udf_name: Identifier
§

AlterUDF(AlterUDFStmt)

§

CreateStage(CreateStageStmt)

§

ShowStages

Fields

§show_options: Option<ShowOptions>
§

DropStage

Fields

§if_exists: bool
§stage_name: String
§

DescribeStage

Fields

§stage_name: String
§

RemoveStage

Fields

§location: String
§pattern: String
§

ListStage

Fields

§location: String
§pattern: Option<String>
§

CreateConnection(CreateConnectionStmt)

§

DropConnection(DropConnectionStmt)

§

DescribeConnection(DescribeConnectionStmt)

§

ShowConnections(ShowConnectionsStmt)

§

CreateFileFormat

Fields

§create_option: CreateOption
§name: String
§file_format_options: FileFormatOptions
§

DropFileFormat

Fields

§if_exists: bool
§name: String
§

ShowFileFormats

§

Presign(PresignStmt)

§

CreateDatamaskPolicy(CreateDatamaskPolicyStmt)

§

DropDatamaskPolicy(DropDatamaskPolicyStmt)

§

DescDatamaskPolicy(DescDatamaskPolicyStmt)

§

CreateNetworkPolicy(CreateNetworkPolicyStmt)

§

AlterNetworkPolicy(AlterNetworkPolicyStmt)

§

DropNetworkPolicy(DropNetworkPolicyStmt)

§

DescNetworkPolicy(DescNetworkPolicyStmt)

§

ShowNetworkPolicies

§

CreatePasswordPolicy(CreatePasswordPolicyStmt)

§

AlterPasswordPolicy(AlterPasswordPolicyStmt)

§

DropPasswordPolicy(DropPasswordPolicyStmt)

§

DescPasswordPolicy(DescPasswordPolicyStmt)

§

ShowPasswordPolicies

Fields

§show_options: Option<ShowOptions>
§

CreateTask(CreateTaskStmt)

§

AlterTask(AlterTaskStmt)

§

ExecuteTask(ExecuteTaskStmt)

§

DescribeTask(DescribeTaskStmt)

§

DropTask(DropTaskStmt)

§

ShowTasks(ShowTasksStmt)

§

CreateDynamicTable(CreateDynamicTableStmt)

§

CreatePipe(CreatePipeStmt)

§

DescribePipe(DescribePipeStmt)

§

DropPipe(DropPipeStmt)

§

AlterPipe(AlterPipeStmt)

§

Begin

§

Commit

§

Abort

§

CreateNotification(CreateNotificationStmt)

§

AlterNotification(AlterNotificationStmt)

§

DropNotification(DropNotificationStmt)

§

DescribeNotification(DescribeNotificationStmt)

§

ExecuteImmediate(ExecuteImmediateStmt)

§

CreateProcedure(CreateProcedureStmt)

§

DropProcedure(DropProcedureStmt)

§

ShowProcedures

Fields

§show_options: Option<ShowOptions>
§

DescProcedure(DescProcedureStmt)

§

CallProcedure(CallProcedureStmt)

§

CreateSequence(CreateSequenceStmt)

§

DropSequence(DropSequenceStmt)

§

ShowSequences

Fields

§show_options: Option<ShowOptions>
§

DescSequence

Fields

§name: Identifier
§

SetPriority

Fields

§priority: Priority
§object_id: String
§

System(SystemStmt)

Implementations§

Trait Implementations§

Source§

impl Clone for Statement

Source§

fn clone(&self) -> Statement

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 Statement

Source§

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

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

impl Display for Statement

Source§

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

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

impl Drive for Statement

Source§

fn drive<V: Visitor>(&self, visitor: &mut V)

Source§

impl DriveMut for Statement

Source§

fn drive_mut<V: VisitorMut>(&mut self, visitor: &mut V)

Source§

impl PartialEq for Statement

Source§

fn eq(&self, other: &Statement) -> 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 Statement

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, 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> ErasedDestructor for T
where T: 'static,