Enum SyntaxKind

Source

pub enum SyntaxKind {
Show 577 variants    Unparsable,
    File,
    ColumnReference,
    ObjectReference,
    Expression,
    WildcardIdentifier,
    Function,
    HavingClause,
    PathSegment,
    LimitClause,
    CubeRollupClause,
    GroupingSetsClause,
    GroupingExpressionList,
    SetClause,
    FetchClause,
    FunctionDefinition,
    AlterSequenceOptionsSegment,
    RoleReference,
    TablespaceReference,
    ExtensionReference,
    TagReference,
    ColumnDefinition,
    ColumnConstraintSegment,
    CommentClause,
    TableEndClause,
    MergeMatch,
    MergeWhenNotMatchedClause,
    MergeInsertClause,
    MergeUpdateClause,
    MergeDeleteClause,
    SetClauseList,
    TableReference,
    GroupbyClause,
    FrameClause,
    WithCompoundStatement,
    CommonTableExpression,
    CTEColumnList,
    TriggerReference,
    TableConstraint,
    JoinOnCondition,
    DatabaseReference,
    CollationReference,
    OverClause,
    NamedWindow,
    WindowSpecification,
    PartitionbyClause,
    JoinClause,
    DropTriggerStatement,
    SampleExpression,
    TableExpression,
    CreateTriggerStatement,
    DropModelStatement,
    DescribeStatement,
    UseStatement,
    ExplainStatement,
    CreateSequenceStatement,
    CreateSequenceOptionsSegment,
    AlterSequenceStatement,
    DropSequenceStatement,
    DropCastStatement,
    CreateFunctionStatement,
    DropFunctionStatement,
    CreateModelStatement,
    CreateViewStatement,
    DeleteStatement,
    UpdateStatement,
    CreateCastStatement,
    CreateRoleStatement,
    DropRoleStatement,
    AlterTableStatement,
    CreateSchemaStatement,
    SetSchemaStatement,
    DropSchemaStatement,
    DropTypeStatement,
    CreateDatabaseStatement,
    DropDatabaseStatement,
    FunctionParameterList,
    CreateIndexStatement,
    DropIndexStatement,
    CreateTableStatement,
    AccessStatement,
    InsertStatement,
    TransactionStatement,
    DropTableStatement,
    DropViewStatement,
    CreateUserStatement,
    DropUserStatement,
    ArrayExpression,
    LocalAlias,
    MergeStatement,
    IndexColumnDefinition,
    AggregateOrderByClause,
    FunctionName,
    CaseExpression,
    WhenClause,
    ElseClause,
    WhereClause,
    SetOperator,
    ValuesClause,
    EmptyStructLiteral,
    ObjectLiteral,
    ObjectLiteralElement,
    TimeZoneGrammar,
    BracketedArguments,
    DataType,
    AliasExpression,
    ArrayAccessor,
    ArrayLiteral,
    TypedArrayLiteral,
    StructType,
    StructLiteral,
    TypedStructLiteral,
    IntervalExpression,
    ArrayType,
    SizedArrayType,
    SelectStatement,
    OverlapsClause,
    SelectClause,
    Statement,
    WithNoSchemaBindingClause,
    WithDataClause,
    SetExpression,
    FromClause,
    EmptyStructLiteralBrackets,
    WildcardExpression,
    OrderbyClause,
    TruncateStatement,
    FromExpression,
    FromExpressionElement,
    SelectClauseModifier,
    NamedWindowExpression,
    SelectClauseElement,
    QualifyClause,
    MultiStatementSegment,
    AssertStatement,
    ForInStatements,
    ForInStatement,
    RepeatStatements,
    RepeatStatement,
    IfStatements,
    IfStatement,
    LoopStatements,
    LoopStatement,
    WhileStatements,
    WhileStatement,
    DatePartWeek,
    SelectExceptClause,
    SelectReplaceClause,
    StructTypeSchema,
    Tuple,
    NamedArgument,
    DeclareSegment,
    SetSegment,
    PartitionBySegment,
    ClusterBySegment,
    OptionsSegment,
    CreateExternalTableStatement,
    AlterViewStatement,
    CreateMaterializedViewStatement,
    AlterMaterializedViewSetOptionsStatement,
    DropMaterializedViewStatement,
    ParameterizedExpression,
    PivotForClause,
    FromPivotExpression,
    UnpivotClause,
    FromUnpivotExpression,
    NotMatchedByTargetClause,
    MergeWhenMatchedClause,
    ProcedureName,
    ExportStatement,
    ProcedureParameterList,
    ProcedureStatements,
    CallStatement,
    ReturnStatement,
    BreakStatement,
    LeaveStatement,
    ContinueStatement,
    RaiseStatement,
    PsqlVariable,
    ComparisonOperator,
    DatetimeTypeIdentifier,
    DatetimeLiteral,
    IndexAccessMethod,
    OperatorClassReference,
    DefinitionParameter,
    DefinitionParameters,
    RelationOption,
    RelationOptions,
    AlterFunctionActionSegment,
    AlterProcedureActionSegment,
    AlterProcedureStatement,
    DropProcedureStatement,
    WktGeometryType,
    IntoClause,
    ForClause,
    AlterRoleStatement,
    ExplainOption,
    CreateTableAsStatement,
    AlterPublicationStatement,
    CreatePublicationStatement,
    PublicationObjects,
    PublicationTable,
    PublicationReference,
    DropExtensionStatement,
    CreateExtensionStatement,
    VersionIdentifier,
    AlterTableActionSegment,
    DropPublicationStatement,
    AlterMaterializedViewStatement,
    AlterMaterializedViewActionSegment,
    RefreshMaterializedViewStatement,
    WithCheckOption,
    AlterPolicyStatement,
    AlterDatabaseStatement,
    VacuumStatement,
    LikeOptionSegment,
    PartitionBoundSpec,
    IndexParameters,
    ReferentialActionSegment,
    IndexElement,
    ExclusionConstraintElement,
    AlterDefaultPrivilegesStatement,
    AlterDefaultPrivilegesObjectPrivilege,
    AlterDefaultPrivilegesSchemaObject,
    AlterDefaultPrivilegesToFromRoles,
    AlterDefaultPrivilegesGrant,
    DropOwnedStatement,
    ReassignOwnedStatement,
    IndexElementOptions,
    AlterDefaultPrivilegesRevoke,
    AlterIndexStatement,
    ReindexStatementSegment,
    AnalyzeStatement,
    AlterTrigger,
    OperationClassReference,
    ConflictAction,
    ConflictTarget,
    SetStatement,
    CreatePolicyStatement,
    CreateDomainStatement,
    AlterDomainStatement,
    DropDomainStatement,
    DropPolicyStatement,
    LoadStatement,
    ResetStatement,
    ListenStatement,
    NotifyStatement,
    UnlistenStatement,
    ClusterStatement,
    LanguageClause,
    DoStatement,
    CreateUserMappingStatement,
    ImportForeignSchemaStatement,
    CreateServerStatement,
    CreateCollationStatement,
    AlterTypeStatement,
    CreateTypeStatement,
    LockTableStatement,
    CopyStatement,
    DiscardStatement,
    AlterSchemaStatement,
    ServerReference,
    ArrayJoinClause,
    TableEngineFunction,
    OnClusterClause,
    Engine,
    EngineFunction,
    DatabaseEngine,
    ColumnTtlSegment,
    TableTtlSegment,
    DropDictionaryStatement,
    DropQuotaStatement,
    DropSettingProfileStatement,
    SystemMergesSegment,
    SystemTtlMergesSegment,
    SystemMovesSegment,
    SystemReplicaSegment,
    SystemFilesystemSegment,
    SystemReplicatedSegment,
    SystemReplicationSegment,
    SystemFetchesSegment,
    SystemDistributedSegment,
    SystemModelSegment,
    SystemFileSegment,
    SystemUnfreezeSegment,
    SystemStatement,
    ConnectbyClause,
    CallSegment,
    WithingroupClause,
    PatternExpression,
    MatchRecognizeClause,
    ChangesClause,
    FromAtExpression,
    FromBeforeExpression,
    SnowflakeKeywordExpression,
    SemiStructuredExpression,
    SelectExcludeClause,
    SelectRenameClause,
    AlterTableTableColumnAction,
    AlterTableClusteringAction,
    AlterTableConstraintAction,
    AlterWarehouseStatement,
    AlterShareStatement,
    AlterStorageIntegrationStatement,
    AlterExternalTableStatement,
    CommentEqualsClause,
    TagBracketedEquals,
    TagEquals,
    CreateCloneStatement,
    CreateDatabaseFromShareStatement,
    CreateProcedureStatement,
    ScriptingBlockStatement,
    ScriptingLetStatement,
    AlterFunctionStatement,
    CreateExternalFunctionStatement,
    WarehouseObjectProperties,
    ConstraintPropertiesSegment,
    CopyOptions,
    SchemaObjectProperties,
    CreateTaskStatement,
    SnowflakeTaskExpressionSegment,
    CreateStatement,
    CreateFileFormatSegment,
    AlterFileFormatSegment,
    CsvFileFormatTypeParameters,
    JsonFileFormatTypeParameters,
    AvroFileFormatTypeParameters,
    OrcFileFormatTypeParameters,
    ParquetFileFormatTypeParameters,
    XmlFileFormatTypeParameters,
    AlterPipeSegment,
    FileFormatSegment,
    FormatTypeOptions,
    CopyIntoLocationStatement,
    CopyIntoTableStatement,
    StorageLocation,
    StageParameters,
    S3ExternalStageParameters,
    GcsExternalStageParameters,
    AzureBlobStorageExternalStageParameters,
    CreateStageStatement,
    AlterStageStatement,
    CreateStreamStatement,
    AlterStreamStatement,
    ShowStatement,
    AlterUserStatement,
    AlterSessionStatement,
    AlterSessionSetStatement,
    AlterSessionUnsetClause,
    AlterTaskStatement,
    AlterTaskSpecialSetClause,
    AlterTaskSetClause,
    AlterTaskUnsetClause,
    ExecuteTaskClause,
    UndropStatement,
    CommentStatement,
    DropExternalTableStatement,
    ListStatement,
    GetStatement,
    PutStatement,
    RemoveStatement,
    CastExpression,
    DropObjectStatement,
    UnsetStatement,
    SqlConfOption,
    BinaryOperator,
    PrimitiveType,
    CreateWidgetStatement,
    ReplaceTableStatement,
    RemoveWidgetStatement,
    UseDatabaseStatement,
    InsertOverwriteDirectoryStatement,
    InsertOverwriteDirectoryHiveFmtStatement,
    LoadDataStatement,
    ClusterByClause,
    DistributeByClause,
    HintFunction,
    SelectHint,
    WithCubeRollupClause,
    SortByClause,
    LateralViewClause,
    PivotClause,
    TransformClause,
    AddFileStatement,
    AddJarStatement,
    AnalyzeTableStatement,
    CacheTable,
    ClearCache,
    ListFileStatement,
    ListJarStatement,
    RefreshStatement,
    UncacheTable,
    FileReference,
    PropertyNameIdentifier,
    GeneratedColumnDefinition,
    IntervalLiteral,
    DescribeHistoryStatement,
    DescribeDetailStatement,
    GenerateManifestFileStatement,
    ConvertToDeltaStatement,
    RestoreTableStatement,
    ConstraintStatement,
    ApplyChangesIntoStatement,
    UsingClause,
    DataSourceFormat,
    IcebergTransformation,
    MsckRepairTableStatement,
    RowFormatClause,
    SkewedByClause,
    Bracketed,
    NumericLiteral,
    Keyword,
    EndOfFile,
    Whitespace,
    Newline,
    NakedIdentifier,
    Unlexable,
    StartBracket,
    EndBracket,
    InlineComment,
    Identifier,
    Raw,
    QuotedIdentifier,
    Star,
    Dot,
    Comma,
    Comment,
    EmitsSegment,
    Literal,
    BareFunction,
    NullLiteral,
    BooleanLiteral,
    BlockComment,
    QuotedLiteral,
    DoubleDivide,
    Meta,
    Colon,
    StatementTerminator,
    StartSquareBracket,
    EndSquareBracket,
    StartCurlyBracket,
    Tilde,
    CastingOperator,
    RawComparisonOperator,
    DatePart,
    Pipe,
    SignIndicator,
    LikeOperator,
    Word,
    DoubleQuote,
    SingleQuote,
    Dash,
    Semicolon,
    BackQuote,
    DollarQuote,
    Not,
    Ampersand,
    Question,
    Percent,
    Divide,
    Minus,
    Plus,
    Caret,
    VerticalBar,
    EndCurlyBracket,
    FunctionNameIdentifier,
    Dedent,
    Indent,
    Implicit,
    AtSignLiteral,
    QuestionMark,
    RightArrow,
    UdfBody,
    StartAngleBracket,
    EndAngleBracket,
    Lambda,
    NakedIdentifierAll,
    ProcedureNameIdentifier,
    Parameter,
    DateConstructorLiteral,
    ProcedureOption,
    ExportOption,
    PropertiesNakedIdentifier,
    Symbol,
    DataTypeIdentifier,
    Placeholder,
    ExecuteScriptStatement,
    AssignmentOperator,
    Batch,
    PivotColumnReference,
    IntoTableClause,
    PasswordAuth,
    ExecuteAsClause,
    UnicodeSingleQuote,
    EscapedSingleQuote,
    UnicodeDoubleQuote,
    JsonOperator,
    At,
    BitStringLiteral,
    DollarNumericLiteral,
    WidgetNameIdentifier,
    FileKeyword,
    SemiStructuredElement,
    BytesDoubleQuote,
    BytesSingleQuote,
    FileFormat,
    FileType,
    StartHint,
    EndHint,
    FunctionAssigner,
    UnquotedFilePath,
    Dollar,
    SystemFunctionName,
    IntegerLiteral,
    StageEncryptionOption,
    BucketPath,
    QuotedStar,
    StagePath,
    FileLiteral,
    BytesQuotedLiteral,
    SignedQuotedLiteral,
    ParameterAssigner,
    ColumnSelector,
    DollarLiteral,
    ExcludeBracketClose,
    WalrusOperator,
    WarehouseSize,
    Variable,
    ExcludeBracketOpen,
    SymlinkFormatManifest,
    StartExcludeBracket,
    CompressionType,
    CopyOnErrorOption,
    ColumnIndexIdentifierSegment,
    ScalingPolicy,
    ValidationModeOption,
    EndExcludeBracket,
    IdentifierList,
    TemplateLoop,
    ColonDelimiter,
    SqlcmdOperator,
    Slice,
    TableEndClauseSegment,
    PragmaStatement,
    PragmaReference,
    Slash,
    DataFormatSegment,
    AuthorizationSegment,
    ColumnAttributeSegment,
    ShowModelStatement,
    CreateExternalSchemaStatement,
    CreateLibraryStatement,
    UnloadStatement,
    DeclareStatement,
    FetchStatement,
    CloseStatement,
    CreateDatashareStatement,
    DescDatashareStatement,
    DropDatashareStatement,
    ShowDatasharesStatement,
    GrantDatashareStatement,
    CreateRlsPolicyStatement,
    ManageRlsPolicyStatement,
    DropRlsPolicyStatement,
    AnalyzeCompressionStatement,
    PartitionedBySegment,
    RowFormatDelimitedSegment,
    ObjectUnpivoting,
    ArrayUnnesting,
    AlterGroup,
    CreateGroup,
    ListaggOverflowClauseSegment,
    UnorderedSelectStatementSegment,
    MapType,
    MapTypeSchema,
    PrepareStatement,
    ExecuteStatement,
}

Variants§

§

ExecuteStatement

Implementations§

Source §

impl SyntaxKind

Source

pub fn indent_val(self) -> i8

Source §

impl SyntaxKind

Source

pub fn as_str(&self) -> &'static str

Trait Implementations§

Source §

impl Clone for SyntaxKind

Source §

fn clone(&self) -> SyntaxKind

Returns a copy 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 SyntaxKind

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for SyntaxKind

Source §

fn default() -> SyntaxKind

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

Source §

impl Extend<SyntaxKind> for SyntaxSet

Source §

fn extend<T: IntoIterator<Item = SyntaxKind>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more

Source §

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

Source §

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

Source §

impl<'_derivative_strum> From<&'_derivative_strum SyntaxKind> for &'static str

Source §

fn from(x: &'_derivative_strum SyntaxKind) -> &'static str

Converts to this type from the input type.

Source §

impl From<SyntaxKind> for &'static str

Source §

fn from(x: SyntaxKind) -> &'static str

Converts to this type from the input type.

Source §

impl FromIterator<SyntaxKind> for SyntaxSet

Source §

fn from_iter<T: IntoIterator<Item = SyntaxKind>>(iter: T) -> Self

Creates a value from an iterator. Read more

Source §

impl FromStr for SyntaxKind

Source §

type Err = ParseError

The associated error which can be returned from parsing.

Source §

fn from_str(s: &str) -> Result<SyntaxKind, <Self as FromStr>::Err>

Parses a string s to return a value of this type. Read more

Source §

impl Hash for SyntaxKind

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Ord for SyntaxKind

Source §

fn cmp(&self, other: &SyntaxKind) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for SyntaxKind

Source §

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

Source §

fn partial_cmp(&self, other: &SyntaxKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

impl TryFrom<&str> for SyntaxKind

Source §

type Error = ParseError

The type returned in the event of a conversion error.

Source §

fn try_from(s: &str) -> Result<SyntaxKind, <Self as TryFrom<&str>>::Error>

Performs the conversion.

Source §

impl Copy for SyntaxKind

Source §

impl Eq for SyntaxKind

Source §

impl StructuralPartialEq for SyntaxKind

Auto Trait Implementations§

§

impl Freeze for SyntaxKind

§

impl RefUnwindSafe for SyntaxKind

§

impl Send for SyntaxKind

§

impl Sync for SyntaxKind

§

impl Unpin for SyntaxKind

§

impl UnwindSafe for SyntaxKind

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> AsAny for T
where T: Any,

Source §

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

Source §

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

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

Source §

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

Source §

impl<T> Config for T

Source §

fn config(self, f: impl FnOnce(&mut Self)) -> Self

Source §

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

Source §

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

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

Source §

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

Source §

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

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

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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());

Source §

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

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

§Example

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

Source §

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

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, U> TryFrom 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>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum SyntaxKindCopy item path

Variants§

Unparsable

File

ColumnReference

ObjectReference

Expression

WildcardIdentifier

Function

HavingClause

PathSegment

LimitClause

CubeRollupClause

GroupingSetsClause

GroupingExpressionList

SetClause

FetchClause

FunctionDefinition

AlterSequenceOptionsSegment

RoleReference

TablespaceReference

ExtensionReference

TagReference

ColumnDefinition

ColumnConstraintSegment

CommentClause

TableEndClause

MergeMatch

MergeWhenNotMatchedClause

MergeInsertClause

MergeUpdateClause

MergeDeleteClause

SetClauseList

TableReference

GroupbyClause

FrameClause

WithCompoundStatement

CommonTableExpression

CTEColumnList

TriggerReference

TableConstraint

JoinOnCondition

DatabaseReference

CollationReference

OverClause

NamedWindow

WindowSpecification

PartitionbyClause

JoinClause

DropTriggerStatement

SampleExpression

TableExpression

CreateTriggerStatement

DropModelStatement

DescribeStatement

UseStatement

ExplainStatement

CreateSequenceStatement

CreateSequenceOptionsSegment

AlterSequenceStatement

DropSequenceStatement

DropCastStatement

CreateFunctionStatement

DropFunctionStatement

CreateModelStatement

CreateViewStatement

DeleteStatement

UpdateStatement

CreateCastStatement

CreateRoleStatement

DropRoleStatement

AlterTableStatement

CreateSchemaStatement

SetSchemaStatement

DropSchemaStatement

DropTypeStatement

CreateDatabaseStatement

DropDatabaseStatement

FunctionParameterList

CreateIndexStatement

Enum SyntaxKind