pub enum VectorOp {
Show 27 variants
Search {
collection: QualifiedCollection,
query_vector: Vec<f32>,
top_k: usize,
ef_search: usize,
metric: DistanceMetric,
filter_bitmap: Option<SurrogateBitmap>,
field_name: String,
rls_filters: Vec<u8>,
inline_prefilter_plan: Option<Box<PhysicalPlan>>,
ann_options: VectorAnnOptions,
skip_payload_fetch: bool,
payload_filters: Vec<PayloadAtom>,
},
Insert {
collection: QualifiedCollection,
vector: Vec<f32>,
dim: usize,
field_name: String,
surrogate: Surrogate,
pk_bytes: Option<Vec<u8>>,
provenance: Option<SyncProvenance>,
},
BatchInsert {
collection: QualifiedCollection,
vectors: Vec<Vec<f32>>,
dim: usize,
surrogates: Vec<Surrogate>,
},
MultiSearch {
collection: QualifiedCollection,
query_vector: Vec<f32>,
top_k: usize,
ef_search: usize,
filter_bitmap: Option<SurrogateBitmap>,
rls_filters: Vec<u8>,
},
Delete {
collection: QualifiedCollection,
vector_id: u32,
},
DeleteBySurrogate {
collection: QualifiedCollection,
surrogate: Option<Surrogate>,
field_name: String,
provenance: Option<SyncProvenance>,
},
SetParams {
collection: QualifiedCollection,
field_name: String,
dim: usize,
m: usize,
ef_construction: usize,
metric: String,
index_type: String,
pq_m: usize,
ivf_cells: usize,
ivf_nprobe: usize,
},
DropIndex {
collection: QualifiedCollection,
field_name: String,
},
QueryStats {
collection: QualifiedCollection,
field_name: String,
},
Seal {
collection: QualifiedCollection,
field_name: String,
},
CompactIndex {
collection: QualifiedCollection,
field_name: String,
},
Rebuild {
collection: QualifiedCollection,
field_name: String,
m: usize,
m0: usize,
ef_construction: usize,
},
SparseInsert {
collection: QualifiedCollection,
field_name: String,
doc_id: String,
entries: Vec<(u32, f32)>,
},
SparseSearch {
collection: QualifiedCollection,
field_name: String,
query_entries: Vec<(u32, f32)>,
top_k: usize,
},
SparseDelete {
collection: QualifiedCollection,
field_name: String,
doc_id: String,
},
MultiVectorInsert {
collection: QualifiedCollection,
field_name: String,
document_surrogate: Surrogate,
pk_bytes: Option<Vec<u8>>,
vectors: Vec<f32>,
count: usize,
dim: usize,
},
MultiVectorDelete {
collection: QualifiedCollection,
field_name: String,
document_surrogate: Surrogate,
},
MultiVectorScoreSearch {
collection: QualifiedCollection,
field_name: String,
query_vector: Vec<f32>,
top_k: usize,
ef_search: usize,
mode: String,
},
DirectUpsert {Show 13 fields
collection: QualifiedCollection,
field: String,
surrogate: Surrogate,
pk_bytes: Vec<u8>,
vector: Vec<f32>,
payload: Vec<u8>,
quantization: VectorQuantization,
storage_dtype: VectorStorageDtype,
payload_indexes: Vec<(String, PayloadIndexKind)>,
returning: Option<ReturningSpec>,
rls_filters: Vec<u8>,
on_conflict_updates: Vec<(String, UpdateValue)>,
rls_write_check: RlsWriteCheck,
},
DirectInsert {
collection: QualifiedCollection,
field: String,
surrogate: Surrogate,
pk_bytes: Vec<u8>,
vector: Vec<f32>,
payload: Vec<u8>,
quantization: VectorQuantization,
storage_dtype: VectorStorageDtype,
payload_indexes: Vec<(String, PayloadIndexKind)>,
returning: Option<ReturningSpec>,
rls_filters: Vec<u8>,
},
DirectInsertIfAbsent {
collection: QualifiedCollection,
field: String,
surrogate: Surrogate,
pk_bytes: Vec<u8>,
vector: Vec<f32>,
payload: Vec<u8>,
quantization: VectorQuantization,
storage_dtype: VectorStorageDtype,
payload_indexes: Vec<(String, PayloadIndexKind)>,
returning: Option<ReturningSpec>,
rls_filters: Vec<u8>,
},
DirectBatchWrite {
collection: QualifiedCollection,
field: String,
intent: VectorDirectWriteIntent,
rows: Vec<VectorDirectRow>,
quantization: VectorQuantization,
storage_dtype: VectorStorageDtype,
payload_indexes: Vec<(String, PayloadIndexKind)>,
returning: Option<ReturningSpec>,
rls_filters: Vec<u8>,
on_conflict_updates: Vec<(String, UpdateValue)>,
rls_write_check: RlsWriteCheck,
},
DirectDelete {
collection: QualifiedCollection,
field: String,
targets: VectorWriteTargets,
returning: Option<ReturningSpec>,
rls_filters: Vec<u8>,
rls_write_check: RlsWriteCheck,
},
DirectTruncate {
collection: QualifiedCollection,
field: String,
restart_identity: bool,
},
DirectUpdate {
collection: QualifiedCollection,
field: String,
targets: VectorWriteTargets,
new_vector: Option<Vec<f32>>,
payload_patch: Vec<(String, UpdateValue)>,
quantization: VectorQuantization,
storage_dtype: VectorStorageDtype,
payload_indexes: Vec<(String, PayloadIndexKind)>,
returning: Option<ReturningSpec>,
rls_filters: Vec<u8>,
rls_write_check: RlsWriteCheck,
},
ResolveDirectWrite(Box<VectorOp>),
ResolvedDirectWrite {
collection: QualifiedCollection,
field: String,
quantization: VectorQuantization,
storage_dtype: VectorStorageDtype,
payload_indexes: Vec<(String, PayloadIndexKind)>,
mutations: Vec<VectorResolvedMutation>,
response_payload: Vec<u8>,
rls_write_check: RlsWriteCheck,
},
}Expand description
Vector engine physical operations.
Variants§
Search
Vector similarity search.
Fields
collection: QualifiedCollectionmetric: DistanceMetricPer-query distance metric override. Overrides the collection-default metric configured at index creation time.
filter_bitmap: Option<SurrogateBitmap>Pre-computed bitmap of eligible surrogates (from filter evaluation).
rls_filters: Vec<u8>RLS post-candidate filters (serialized Vec<ScanFilter>).
Applied after HNSW returns candidates, before returning to client.
Result count may be less than requested top_k.
inline_prefilter_plan: Option<Box<PhysicalPlan>>Optional sub-plan whose output rows materialize a SurrogateBitmap
used as an additional prefilter (intersected with filter_bitmap).
Set by the planner when fusing Vector ORDER BY ... + JOIN ARRAY_SLICE(...) ON v.id = s.surrogate into a single op:
the array slice runs first, its surrogate column becomes the
vector engine’s pre-filter, then HNSW search runs against the
reduced candidate set. Mirrors HashJoin’s inline_*_bitmap
mechanism so the Data Plane composition is uniform.
ann_options: VectorAnnOptionsANN tuning knobs from the SQL caller. Defaults to no overrides.
skip_payload_fetch: boolWhen true, the SELECT projection contains only id and/or
vector_distance(...) — no payload fields. The handler skips
the document-body fetch. Ignored (treated as false) when RLS
filters are active, as body fetch is required for RLS evaluation.
payload_filters: Vec<PayloadAtom>Optional payload bitmap pre-filter for vector-primary collections.
Each atom is Eq / In / Range — the handler ANDs all atoms
and intersects the resulting bitmap with the HNSW candidate set
before walking. The planner only emits atoms whose field has a
registered payload index of the matching kind. Empty means no
payload pre-filter.
Insert
Insert a vector into the HNSW index (write path).
Fields
collection: QualifiedCollectionsurrogate: SurrogateGlobal surrogate identifying this row. Allocated by the
Control Plane via SurrogateAssigner before dispatch; the
engine binds the HNSW node id to this surrogate.
pk_bytes: Option<Vec<u8>>User PK bytes (UTF-8 of the document id) when the insert
originates from a PK-bearing path; None for headless
inserts. Carried on the replication wire so followers bind
the leader-assigned surrogate to this exact key rather than
re-allocating a divergent one.
provenance: Option<SyncProvenance>Sync provenance: identifies the originating peer and sequence for idempotency.
BatchInsert
Batch insert vectors into the HNSW index.
Fields
collection: QualifiedCollectionMultiSearch
Multi-vector search: query across all named vector fields, fuse via RRF.
Delete
Soft-delete a vector by internal node ID.
DeleteBySurrogate
Soft-delete a vector by surrogate (sync inbound path).
The Data Plane resolves surrogate → HNSW node_id via the
surrogate_to_local map and tombstones the node. If the surrogate
is not found the op is a no-op (idempotent).
Fields
collection: QualifiedCollectionsurrogate: Option<Surrogate>The row’s bound surrogate. None when the key’s home binds none:
the delete removes nothing and still commits its sync provenance.
provenance: Option<SyncProvenance>Sync provenance: identifies the originating peer and sequence for idempotency.
SetParams
Set vector index parameters for a collection.
Fields
collection: QualifiedCollectionfield_name: StringNamed vector field this config applies to. Empty string = the
default (unnamed) vector field. Lets one collection carry
multiple vector indexes, one per VECTOR / embedding column.
DropIndex
Tear down one vector index: the materialized graph, its build parameters, its declared dimension, and its on-disk checkpoint.
The counterpart of VectorOp::SetParams. Without it a dropped
vector index keeps answering searches until the process restarts and
keeps its (collection, field) slot occupied so no replacement index
can be created.
Fields
collection: QualifiedCollectionQueryStats
Query live vector index statistics. Returns VectorIndexStats as payload.
Fields
collection: QualifiedCollectionSeal
Force-seal the growing segment, triggering background HNSW build.
Fields
collection: QualifiedCollectionCompactIndex
Force tombstone compaction on sealed segments.
Fields
collection: QualifiedCollectionRebuild
Rebuild sealed segments with new HNSW parameters. Old index serves queries until rebuild completes, then swaps atomically.
Fields
collection: QualifiedCollectionSparseInsert
Insert a sparse vector into the inverted index.
Fields
collection: QualifiedCollectionSparseSearch
Search the sparse inverted index via dot-product scoring.
Fields
collection: QualifiedCollectionSparseDelete
Delete a document from the sparse inverted index.
Fields
collection: QualifiedCollectionMultiVectorInsert
Insert multiple vectors for a single document (ColBERT-style).
All vectors are inserted as separate HNSW nodes sharing the
same document_surrogate.
Fields
collection: QualifiedCollectionMultiVectorDelete
Delete all vectors for a document from the multi-vector index.
Fields
collection: QualifiedCollectionMultiVectorScoreSearch
Search with multi-vector aggregated scoring (MaxSim, AvgSim, SumSim). Over-fetches from HNSW, groups by doc_id, aggregates, deduplicates.
Fields
collection: QualifiedCollectionDirectUpsert
Direct vector upsert for vector-primary collections: an existing
primary key is replaced whole, or patched by on_conflict_updates.
Bypasses MessagePack document encoding — the Data Plane binds the
vector to an HNSW node, updates the payload bitmap indexes from
payload, and stores payload as the row’s sidecar. No
full-document blob is written.
Ordering invariant (enforced by the handler):
- Validate dim and storage dtype.
- Decode
payloadbytes and probe the surrogate. - Remove the old node, bitmap entries, and sidecar when one exists.
- Insert into HNSW (surrogate bound) and update the bitmap indexes.
- Store the sidecar; a failed store rolls step 4 back.
Fields
collection: QualifiedCollectionfield: StringVector column name. Used to compute the vector index key so the
SELECT path (which keys by (tid, collection, field)) finds the
same index this insert wrote into.
pk_bytes: Vec<u8>UTF-8 of the declared primary-key value. Followers bind the leader-assigned surrogate to this exact key.
payload: Vec<u8>Pre-encoded MessagePack of every non-vector column the statement supplied. Empty when the row carried none.
Only the fields named in payload_indexes become bitmap-indexed
downstream; the rest travel here so the whole row image is available
to whatever has to decide it — a row-level-security write policy
among them.
quantization: VectorQuantizationCollection-level quantization. Applied via set_quantization on
first insert so subsequent seals trigger codec-dispatch rebuilds
against the configured codec (RaBitQ / BBQ).
storage_dtype: VectorStorageDtypeNative storage dtype for vector values (F32 / F16 / BF16). The executor uses this to decide whether to transcode incoming f32 components before writing them into the HNSW index backing store.
payload_indexes: Vec<(String, PayloadIndexKind)>Payload field bitmap indexes (name + kind). Registered via
payload.add_index on the first insert into a new collection.
returning: Option<ReturningSpec>When Some, return the STORED post-image of the upserted row — the
metadata sidecar as it exists after the handler wrote it, decoded
through the same normalizer the SELECT scan uses, so the returned
row renders identically to a later read. Never the submitted values:
the sidecar is zerompk TAGGED bytes and echoing the request would
report a shape no read of the collection ever produces.
The vector goes to HNSW, every other column to the sidecar, and there is no companion document write to carry the clause instead.
rls_filters: Vec<u8>Read filters gating the row returning emits. A vector-primary
write’s policy admission happens Control-Plane-side against the
payload image (RlsCtx::admit_write_value_map_image), which
decides whether the write happens at all; this bounds what may be
shown back, so a RETURNING row never exceeds a SELECT by the
same principal.
on_conflict_updates: Vec<(String, UpdateValue)>ON CONFLICT (pk) DO UPDATE SET assignments applied to the stored
payload when the key exists. Empty means whole-row replace.
rls_write_check: RlsWriteCheckWrite policy for the merged post-image an on_conflict_updates
patch produces; the image exists only on the Data Plane. Decided
Control-Plane-side when the patch is empty.
DirectInsert
Vector-primary INSERT: an existing primary key raises
unique_violation. Same fields as VectorOp::DirectUpsert minus
the conflict patch.
Fields
collection: QualifiedCollectionquantization: VectorQuantizationstorage_dtype: VectorStorageDtypepayload_indexes: Vec<(String, PayloadIndexKind)>returning: Option<ReturningSpec>DirectInsertIfAbsent
Vector-primary INSERT ... ON CONFLICT DO NOTHING: an existing
primary key leaves the stored row alone and reports zero rows.
Fields
collection: QualifiedCollectionquantization: VectorQuantizationstorage_dtype: VectorStorageDtypepayload_indexes: Vec<(String, PayloadIndexKind)>returning: Option<ReturningSpec>DirectBatchWrite
Multi-row vector-primary INSERT / INSERT ... ON CONFLICT /
UPSERT: one statement, one page. Every row is judged before any
row lands, so the page lands whole or not at all.
Each row means what one DirectInsert / DirectInsertIfAbsent /
DirectUpsert of the same intent means, applied in page order. A
key the page names twice is judged against the body its earlier row
produced, and is stored once, with the final body.
The page always resolves to a VectorOp::ResolvedDirectWrite
before it is logged or replicated: the record names the rows the page
stores, so replay never judges existence again.
Fields
collection: QualifiedCollectionintent: VectorDirectWriteIntentWhat an existing key means for every row of the page.
rows: Vec<VectorDirectRow>The rows, in statement order.
quantization: VectorQuantizationstorage_dtype: VectorStorageDtypepayload_indexes: Vec<(String, PayloadIndexKind)>returning: Option<ReturningSpec>When Some, return one row per row the page writes, each its
key’s stored post-image.
on_conflict_updates: Vec<(String, UpdateValue)>See DirectUpsert::on_conflict_updates. Only an Upsert page
carries one; one clause for every row.
rls_write_check: RlsWriteCheckSee DirectUpsert::rls_write_check.
DirectDelete
Vector-primary DELETE. Removes the HNSW node, its payload bitmap
entries, and the payload sidecar row of every targeted surrogate.
Reports the number of rows that existed.
Fields
collection: QualifiedCollectiontargets: VectorWriteTargetsreturning: Option<ReturningSpec>When Some, return the removed rows’ sidecar images.
rls_write_check: RlsWriteCheckWrite policy decided against each removed row’s sidecar image.
DirectTruncate
Vector-primary TRUNCATE. Removes every live row of the collection’s
primary index: each HNSW node, its payload bitmap entries, and its
payload sidecar row. Reports the number of rows that existed.
Fields
collection: QualifiedCollectionDirectUpdate
Vector-primary UPDATE. A new_vector rebuilds the HNSW node under
the same surrogate; payload_patch merges into the sidecar and moves
the payload bitmap entries. Reports the number of rows that existed.
Fields
collection: QualifiedCollectiontargets: VectorWriteTargetspayload_patch: Vec<(String, UpdateValue)>Assignments to non-vector columns, applied to the stored payload.
quantization: VectorQuantizationstorage_dtype: VectorStorageDtypepayload_indexes: Vec<(String, PayloadIndexKind)>returning: Option<ReturningSpec>When Some, return the rows’ stored post-images.
rls_write_check: RlsWriteCheckWrite policy decided against each row’s post-image.
ResolveDirectWrite(Box<VectorOp>)
Read-only: report every row mutation the wrapped vector-primary write would apply, and the response payload it would return, without applying anything.
Wraps a VectorOp::DirectDelete, VectorOp::DirectUpdate,
VectorOp::DirectUpsert, or VectorOp::DirectBatchWrite
verbatim, live write predicate included —
the handler resolves the targets, reads each row’s sidecar, computes
the post-image, and decides the policy here, where the writing
identity is still available. A follower has none, so the predicate
can never cross the Raft wire.
ResolvedDirectWrite
Apply exactly the mutations a VectorOp::ResolveDirectWrite
reported, then return response_payload verbatim.
No predicate is evaluated and no image is recomputed: the Control
Plane already decided both, and rls_write_check carries the verdict
(RlsWriteCheck::DecidedEarlierInRequest). Every mutation’s pre-image
is checked against the stored sidecar before the first one applies,
so a resolution that drifted under a concurrent write applies nothing
and asks for a retry.
Fields
collection: QualifiedCollectionquantization: VectorQuantizationIndex settings a first write into a new index registers; an
Upsert mutation into an empty collection creates the index.
storage_dtype: VectorStorageDtypepayload_indexes: Vec<(String, PayloadIndexKind)>mutations: Vec<VectorResolvedMutation>response_payload: Vec<u8>The statement’s reply, decided while resolving. Applying nodes return it unchanged, so leader and follower report the same thing.
rls_write_check: RlsWriteCheckImplementations§
Source§impl VectorOp
impl VectorOp
Sourcepub fn direct_write_collection(&self) -> Option<&str>
pub fn direct_write_collection(&self) -> Option<&str>
The vector-primary collection a direct write targets, or None for
every op outside that family. ResolveDirectWrite reports the wrapped
write’s collection so the resolve dispatch routes to the core that
owns exactly the rows the write reads.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for VectorOp
impl<'de> Deserialize<'de> for VectorOp
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for VectorOp
impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for VectorOp
impl StructuralPartialEq for VectorOp
Source§impl ToMessagePack for VectorOp
impl ToMessagePack for VectorOp
Source§fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>
fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>
Source§fn write_slice<W>(values: &[Self], writer: &mut W) -> Result<(), Error>
fn write_slice<W>(values: &[Self], writer: &mut W) -> Result<(), Error>
Source§fn size_hint(&self) -> Option<TrustedSizeHint>
fn size_hint(&self) -> Option<TrustedSizeHint>
Self::write, or None when it cannot be determined cheaply. Read moreAuto Trait Implementations§
impl Freeze for VectorOp
impl RefUnwindSafe for VectorOp
impl Send for VectorOp
impl Sync for VectorOp
impl Unpin for VectorOp
impl UnsafeUnpin for VectorOp
impl UnwindSafe for VectorOp
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> FromMessagePackOwned for Twhere
T: for<'a> FromMessagePack<'a>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out indicating that a T is niched.Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
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§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<T> Rleable for T
impl<T> Scalar for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.