Struct pgx_pg_sys::TableAmRoutine
source · [−]#[repr(C)]pub struct TableAmRoutine {Show 46 fields
pub type_: NodeTag,
pub slot_callbacks: Option<unsafe extern "C" fn(rel: Relation) -> *const TupleTableSlotOps>,
pub scan_begin: Option<unsafe extern "C" fn(rel: Relation, snapshot: Snapshot, nkeys: c_int, key: *mut ScanKeyData, pscan: ParallelTableScanDesc, flags: uint32) -> TableScanDesc>,
pub scan_end: Option<unsafe extern "C" fn(scan: TableScanDesc)>,
pub scan_rescan: Option<unsafe extern "C" fn(scan: TableScanDesc, key: *mut ScanKeyData, set_params: bool, allow_strat: bool, allow_sync: bool, allow_pagemode: bool)>,
pub scan_getnextslot: Option<unsafe extern "C" fn(scan: TableScanDesc, direction: ScanDirection, slot: *mut TupleTableSlot) -> bool>,
pub scan_set_tidrange: Option<unsafe extern "C" fn(scan: TableScanDesc, mintid: ItemPointer, maxtid: ItemPointer)>,
pub scan_getnextslot_tidrange: Option<unsafe extern "C" fn(scan: TableScanDesc, direction: ScanDirection, slot: *mut TupleTableSlot) -> bool>,
pub parallelscan_estimate: Option<unsafe extern "C" fn(rel: Relation) -> Size>,
pub parallelscan_initialize: Option<unsafe extern "C" fn(rel: Relation, pscan: ParallelTableScanDesc) -> Size>,
pub parallelscan_reinitialize: Option<unsafe extern "C" fn(rel: Relation, pscan: ParallelTableScanDesc)>,
pub index_fetch_begin: Option<unsafe extern "C" fn(rel: Relation) -> *mut IndexFetchTableData>,
pub index_fetch_reset: Option<unsafe extern "C" fn(data: *mut IndexFetchTableData)>,
pub index_fetch_end: Option<unsafe extern "C" fn(data: *mut IndexFetchTableData)>,
pub index_fetch_tuple: Option<unsafe extern "C" fn(scan: *mut IndexFetchTableData, tid: ItemPointer, snapshot: Snapshot, slot: *mut TupleTableSlot, call_again: *mut bool, all_dead: *mut bool) -> bool>,
pub tuple_fetch_row_version: Option<unsafe extern "C" fn(rel: Relation, tid: ItemPointer, snapshot: Snapshot, slot: *mut TupleTableSlot) -> bool>,
pub tuple_tid_valid: Option<unsafe extern "C" fn(scan: TableScanDesc, tid: ItemPointer) -> bool>,
pub tuple_get_latest_tid: Option<unsafe extern "C" fn(scan: TableScanDesc, tid: ItemPointer)>,
pub tuple_satisfies_snapshot: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, snapshot: Snapshot) -> bool>,
pub index_delete_tuples: Option<unsafe extern "C" fn(rel: Relation, delstate: *mut TM_IndexDeleteOp) -> TransactionId>,
pub tuple_insert: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, cid: CommandId, options: c_int, bistate: *mut BulkInsertStateData)>,
pub tuple_insert_speculative: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, cid: CommandId, options: c_int, bistate: *mut BulkInsertStateData, specToken: uint32)>,
pub tuple_complete_speculative: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, specToken: uint32, succeeded: bool)>,
pub multi_insert: Option<unsafe extern "C" fn(rel: Relation, slots: *mut *mut TupleTableSlot, nslots: c_int, cid: CommandId, options: c_int, bistate: *mut BulkInsertStateData)>,
pub tuple_delete: Option<unsafe extern "C" fn(rel: Relation, tid: ItemPointer, cid: CommandId, snapshot: Snapshot, crosscheck: Snapshot, wait: bool, tmfd: *mut TM_FailureData, changingPart: bool) -> TM_Result>,
pub tuple_update: Option<unsafe extern "C" fn(rel: Relation, otid: ItemPointer, slot: *mut TupleTableSlot, cid: CommandId, snapshot: Snapshot, crosscheck: Snapshot, wait: bool, tmfd: *mut TM_FailureData, lockmode: *mut LockTupleMode, update_indexes: *mut bool) -> TM_Result>,
pub tuple_lock: Option<unsafe extern "C" fn(rel: Relation, tid: ItemPointer, snapshot: Snapshot, slot: *mut TupleTableSlot, cid: CommandId, mode: LockTupleMode, wait_policy: LockWaitPolicy, flags: uint8, tmfd: *mut TM_FailureData) -> TM_Result>,
pub finish_bulk_insert: Option<unsafe extern "C" fn(rel: Relation, options: c_int)>,
pub relation_set_new_filenode: Option<unsafe extern "C" fn(rel: Relation, newrnode: *const RelFileNode, persistence: c_char, freezeXid: *mut TransactionId, minmulti: *mut MultiXactId)>,
pub relation_nontransactional_truncate: Option<unsafe extern "C" fn(rel: Relation)>,
pub relation_copy_data: Option<unsafe extern "C" fn(rel: Relation, newrnode: *const RelFileNode)>,
pub relation_copy_for_cluster: Option<unsafe extern "C" fn(NewTable: Relation, OldTable: Relation, OldIndex: Relation, use_sort: bool, OldestXmin: TransactionId, xid_cutoff: *mut TransactionId, multi_cutoff: *mut MultiXactId, num_tuples: *mut f64, tups_vacuumed: *mut f64, tups_recently_dead: *mut f64)>,
pub relation_vacuum: Option<unsafe extern "C" fn(rel: Relation, params: *mut VacuumParams, bstrategy: BufferAccessStrategy)>,
pub scan_analyze_next_block: Option<unsafe extern "C" fn(scan: TableScanDesc, blockno: BlockNumber, bstrategy: BufferAccessStrategy) -> bool>,
pub scan_analyze_next_tuple: Option<unsafe extern "C" fn(scan: TableScanDesc, OldestXmin: TransactionId, liverows: *mut f64, deadrows: *mut f64, slot: *mut TupleTableSlot) -> bool>,
pub index_build_range_scan: Option<unsafe extern "C" fn(table_rel: Relation, index_rel: Relation, index_info: *mut IndexInfo, allow_sync: bool, anyvisible: bool, progress: bool, start_blockno: BlockNumber, numblocks: BlockNumber, callback: IndexBuildCallback, callback_state: *mut c_void, scan: TableScanDesc) -> f64>,
pub index_validate_scan: Option<unsafe extern "C" fn(table_rel: Relation, index_rel: Relation, index_info: *mut IndexInfo, snapshot: Snapshot, state: *mut ValidateIndexState)>,
pub relation_size: Option<unsafe extern "C" fn(rel: Relation, forkNumber: ForkNumber) -> uint64>,
pub relation_needs_toast_table: Option<unsafe extern "C" fn(rel: Relation) -> bool>,
pub relation_toast_am: Option<unsafe extern "C" fn(rel: Relation) -> Oid>,
pub relation_fetch_toast_slice: Option<unsafe extern "C" fn(toastrel: Relation, valueid: Oid, attrsize: int32, sliceoffset: int32, slicelength: int32, result: *mut varlena)>,
pub relation_estimate_size: Option<unsafe extern "C" fn(rel: Relation, attr_widths: *mut int32, pages: *mut BlockNumber, tuples: *mut f64, allvisfrac: *mut f64)>,
pub scan_bitmap_next_block: Option<unsafe extern "C" fn(scan: TableScanDesc, tbmres: *mut TBMIterateResult) -> bool>,
pub scan_bitmap_next_tuple: Option<unsafe extern "C" fn(scan: TableScanDesc, tbmres: *mut TBMIterateResult, slot: *mut TupleTableSlot) -> bool>,
pub scan_sample_next_block: Option<unsafe extern "C" fn(scan: TableScanDesc, scanstate: *mut SampleScanState) -> bool>,
pub scan_sample_next_tuple: Option<unsafe extern "C" fn(scan: TableScanDesc, scanstate: *mut SampleScanState, slot: *mut TupleTableSlot) -> bool>,
}Fields
type_: NodeTagslot_callbacks: Option<unsafe extern "C" fn(rel: Relation) -> *const TupleTableSlotOps>scan_begin: Option<unsafe extern "C" fn(rel: Relation, snapshot: Snapshot, nkeys: c_int, key: *mut ScanKeyData, pscan: ParallelTableScanDesc, flags: uint32) -> TableScanDesc>scan_end: Option<unsafe extern "C" fn(scan: TableScanDesc)>scan_rescan: Option<unsafe extern "C" fn(scan: TableScanDesc, key: *mut ScanKeyData, set_params: bool, allow_strat: bool, allow_sync: bool, allow_pagemode: bool)>scan_getnextslot: Option<unsafe extern "C" fn(scan: TableScanDesc, direction: ScanDirection, slot: *mut TupleTableSlot) -> bool>scan_set_tidrange: Option<unsafe extern "C" fn(scan: TableScanDesc, mintid: ItemPointer, maxtid: ItemPointer)>scan_getnextslot_tidrange: Option<unsafe extern "C" fn(scan: TableScanDesc, direction: ScanDirection, slot: *mut TupleTableSlot) -> bool>parallelscan_estimate: Option<unsafe extern "C" fn(rel: Relation) -> Size>parallelscan_initialize: Option<unsafe extern "C" fn(rel: Relation, pscan: ParallelTableScanDesc) -> Size>parallelscan_reinitialize: Option<unsafe extern "C" fn(rel: Relation, pscan: ParallelTableScanDesc)>index_fetch_begin: Option<unsafe extern "C" fn(rel: Relation) -> *mut IndexFetchTableData>index_fetch_reset: Option<unsafe extern "C" fn(data: *mut IndexFetchTableData)>index_fetch_end: Option<unsafe extern "C" fn(data: *mut IndexFetchTableData)>index_fetch_tuple: Option<unsafe extern "C" fn(scan: *mut IndexFetchTableData, tid: ItemPointer, snapshot: Snapshot, slot: *mut TupleTableSlot, call_again: *mut bool, all_dead: *mut bool) -> bool>tuple_fetch_row_version: Option<unsafe extern "C" fn(rel: Relation, tid: ItemPointer, snapshot: Snapshot, slot: *mut TupleTableSlot) -> bool>tuple_tid_valid: Option<unsafe extern "C" fn(scan: TableScanDesc, tid: ItemPointer) -> bool>tuple_get_latest_tid: Option<unsafe extern "C" fn(scan: TableScanDesc, tid: ItemPointer)>tuple_satisfies_snapshot: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, snapshot: Snapshot) -> bool>index_delete_tuples: Option<unsafe extern "C" fn(rel: Relation, delstate: *mut TM_IndexDeleteOp) -> TransactionId>tuple_insert: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, cid: CommandId, options: c_int, bistate: *mut BulkInsertStateData)>tuple_insert_speculative: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, cid: CommandId, options: c_int, bistate: *mut BulkInsertStateData, specToken: uint32)>tuple_complete_speculative: Option<unsafe extern "C" fn(rel: Relation, slot: *mut TupleTableSlot, specToken: uint32, succeeded: bool)>multi_insert: Option<unsafe extern "C" fn(rel: Relation, slots: *mut *mut TupleTableSlot, nslots: c_int, cid: CommandId, options: c_int, bistate: *mut BulkInsertStateData)>tuple_delete: Option<unsafe extern "C" fn(rel: Relation, tid: ItemPointer, cid: CommandId, snapshot: Snapshot, crosscheck: Snapshot, wait: bool, tmfd: *mut TM_FailureData, changingPart: bool) -> TM_Result>tuple_update: Option<unsafe extern "C" fn(rel: Relation, otid: ItemPointer, slot: *mut TupleTableSlot, cid: CommandId, snapshot: Snapshot, crosscheck: Snapshot, wait: bool, tmfd: *mut TM_FailureData, lockmode: *mut LockTupleMode, update_indexes: *mut bool) -> TM_Result>tuple_lock: Option<unsafe extern "C" fn(rel: Relation, tid: ItemPointer, snapshot: Snapshot, slot: *mut TupleTableSlot, cid: CommandId, mode: LockTupleMode, wait_policy: LockWaitPolicy, flags: uint8, tmfd: *mut TM_FailureData) -> TM_Result>finish_bulk_insert: Option<unsafe extern "C" fn(rel: Relation, options: c_int)>relation_set_new_filenode: Option<unsafe extern "C" fn(rel: Relation, newrnode: *const RelFileNode, persistence: c_char, freezeXid: *mut TransactionId, minmulti: *mut MultiXactId)>relation_nontransactional_truncate: Option<unsafe extern "C" fn(rel: Relation)>relation_copy_data: Option<unsafe extern "C" fn(rel: Relation, newrnode: *const RelFileNode)>relation_copy_for_cluster: Option<unsafe extern "C" fn(NewTable: Relation, OldTable: Relation, OldIndex: Relation, use_sort: bool, OldestXmin: TransactionId, xid_cutoff: *mut TransactionId, multi_cutoff: *mut MultiXactId, num_tuples: *mut f64, tups_vacuumed: *mut f64, tups_recently_dead: *mut f64)>relation_vacuum: Option<unsafe extern "C" fn(rel: Relation, params: *mut VacuumParams, bstrategy: BufferAccessStrategy)>scan_analyze_next_block: Option<unsafe extern "C" fn(scan: TableScanDesc, blockno: BlockNumber, bstrategy: BufferAccessStrategy) -> bool>scan_analyze_next_tuple: Option<unsafe extern "C" fn(scan: TableScanDesc, OldestXmin: TransactionId, liverows: *mut f64, deadrows: *mut f64, slot: *mut TupleTableSlot) -> bool>index_build_range_scan: Option<unsafe extern "C" fn(table_rel: Relation, index_rel: Relation, index_info: *mut IndexInfo, allow_sync: bool, anyvisible: bool, progress: bool, start_blockno: BlockNumber, numblocks: BlockNumber, callback: IndexBuildCallback, callback_state: *mut c_void, scan: TableScanDesc) -> f64>index_validate_scan: Option<unsafe extern "C" fn(table_rel: Relation, index_rel: Relation, index_info: *mut IndexInfo, snapshot: Snapshot, state: *mut ValidateIndexState)>relation_size: Option<unsafe extern "C" fn(rel: Relation, forkNumber: ForkNumber) -> uint64>relation_needs_toast_table: Option<unsafe extern "C" fn(rel: Relation) -> bool>relation_toast_am: Option<unsafe extern "C" fn(rel: Relation) -> Oid>relation_fetch_toast_slice: Option<unsafe extern "C" fn(toastrel: Relation, valueid: Oid, attrsize: int32, sliceoffset: int32, slicelength: int32, result: *mut varlena)>relation_estimate_size: Option<unsafe extern "C" fn(rel: Relation, attr_widths: *mut int32, pages: *mut BlockNumber, tuples: *mut f64, allvisfrac: *mut f64)>scan_bitmap_next_block: Option<unsafe extern "C" fn(scan: TableScanDesc, tbmres: *mut TBMIterateResult) -> bool>scan_bitmap_next_tuple: Option<unsafe extern "C" fn(scan: TableScanDesc, tbmres: *mut TBMIterateResult, slot: *mut TupleTableSlot) -> bool>scan_sample_next_block: Option<unsafe extern "C" fn(scan: TableScanDesc, scanstate: *mut SampleScanState) -> bool>scan_sample_next_tuple: Option<unsafe extern "C" fn(scan: TableScanDesc, scanstate: *mut SampleScanState, slot: *mut TupleTableSlot) -> bool>Trait Implementations
sourceimpl Clone for TableAmRoutine
impl Clone for TableAmRoutine
sourcefn clone(&self) -> TableAmRoutine
fn clone(&self) -> TableAmRoutine
Returns a copy of the value. Read more
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresourceimpl Debug for TableAmRoutine
impl Debug for TableAmRoutine
sourceimpl Default for TableAmRoutine
impl Default for TableAmRoutine
sourceimpl Display for TableAmRoutine
impl Display for TableAmRoutine
sourceimpl PgNode for TableAmRoutine
impl PgNode for TableAmRoutine
type NodeType = TableAmRoutine
sourcefn as_node_ptr(&self) -> *mut Self::NodeType
fn as_node_ptr(&self) -> *mut Self::NodeType
Represent this node as a mutable pointer of its type
impl Copy for TableAmRoutine
Auto Trait Implementations
impl RefUnwindSafe for TableAmRoutine
impl Send for TableAmRoutine
impl Sync for TableAmRoutine
impl Unpin for TableAmRoutine
impl UnwindSafe for TableAmRoutine
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<D> OwoColorize for D
impl<D> OwoColorize for D
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Set the foreground color generically Read more
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Set the background color generically. Read more
fn black(&'a self) -> FgColorDisplay<'a, Black, Self>
fn black(&'a self) -> FgColorDisplay<'a, Black, Self>
Change the foreground color to black
fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>
fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>
Change the background color to black
fn red(&'a self) -> FgColorDisplay<'a, Red, Self>
fn red(&'a self) -> FgColorDisplay<'a, Red, Self>
Change the foreground color to red
fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>
fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>
Change the background color to red
fn green(&'a self) -> FgColorDisplay<'a, Green, Self>
fn green(&'a self) -> FgColorDisplay<'a, Green, Self>
Change the foreground color to green
fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>
fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>
Change the background color to green
fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>
fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>
Change the foreground color to yellow
fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>
fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>
Change the background color to yellow
fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>
fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>
Change the foreground color to blue
fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>
fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>
Change the background color to blue
fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>
fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>
Change the foreground color to magenta
fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>
Change the background color to magenta
fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>
fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>
Change the foreground color to purple
fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>
fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>
Change the background color to purple
fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>
fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>
Change the foreground color to cyan
fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>
fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>
Change the background color to cyan
fn white(&'a self) -> FgColorDisplay<'a, White, Self>
fn white(&'a self) -> FgColorDisplay<'a, White, Self>
Change the foreground color to white
fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>
fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>
Change the background color to white
fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>
fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>
Change the foreground color to the terminal default
fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>
fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>
Change the background color to the terminal default
fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
Change the foreground color to bright black
fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
Change the background color to bright black
fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
Change the foreground color to bright red
fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
Change the background color to bright red
fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
Change the foreground color to bright green
fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
Change the background color to bright green
fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
Change the foreground color to bright yellow
fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
Change the background color to bright yellow
fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
Change the foreground color to bright blue
fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
Change the background color to bright blue
fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
Change the foreground color to bright magenta
fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
Change the background color to bright magenta
fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
Change the foreground color to bright purple
fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
Change the background color to bright purple
fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
Change the foreground color to bright cyan
fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
Change the background color to bright cyan
fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
Change the foreground color to bright white
fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
Change the background color to bright white
fn bold(&'a self) -> BoldDisplay<'a, Self>
fn bold(&'a self) -> BoldDisplay<'a, Self>
Make the text bold
fn dimmed(&'a self) -> DimDisplay<'a, Self>
fn dimmed(&'a self) -> DimDisplay<'a, Self>
Make the text dim
fn italic(&'a self) -> ItalicDisplay<'a, Self>
fn italic(&'a self) -> ItalicDisplay<'a, Self>
Make the text italicized
fn underline(&'a self) -> UnderlineDisplay<'a, Self>
fn underline(&'a self) -> UnderlineDisplay<'a, Self>
Make the text italicized
fn blink(&'a self) -> BlinkDisplay<'a, Self>
fn blink(&'a self) -> BlinkDisplay<'a, Self>
Make the text blink
fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>
fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>
Make the text blink (but fast!)
fn reversed(&'a self) -> ReversedDisplay<'a, Self>
fn reversed(&'a self) -> ReversedDisplay<'a, Self>
Swap the foreground and background colors
Hide the text
fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>
fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>
Cross out the text
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either
OwoColorize::fg or
a color-specific method, such as OwoColorize::green, Read morefn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either
OwoColorize::bg or
a color-specific method, such as OwoColorize::on_yellow, Read morefn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.