Trait WitBoundary 

pub trait WitBoundary: Sized {
    type Wit;

    // Required methods
    fn to_wit(&self) -> Result<Self::Wit, String>;
    fn from_wit(wit: Self::Wit) -> Result<Self, String>;
}

Converts a native host type to/from its generated WIT mirror.

to_wit borrows the native value (the host owns it); from_wit consumes the WIT value (it arrived by value across the boundary). Both return Result<_, String> — the WIT result<_, string> convention — so a value that cannot be represented in the current WIT surface is a typed error, not a panic or a silent drop.

Required Associated Types

type Wit

The generated WIT mirror type.

Required Methods

fn to_wit(&self) -> Result<Self::Wit, String>

Project the native value into its owned WIT mirror.

fn from_wit(wit: Self::Wit) -> Result<Self, String>

Reconstruct the native value from its WIT mirror.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl WitBoundary for Annotation

type Wit = Annotation

fn to_wit(&self) -> Result<WitAnnotation, String>

fn from_wit(wit: WitAnnotation) -> Result<Self, String>

impl WitBoundary for AppEffect

type Wit = AppEffect

fn to_wit(&self) -> Result<WitAppEffect, String>

fn from_wit(w: WitAppEffect) -> Result<Self, String>

impl WitBoundary for AppliedEdit

type Wit = AppliedEdit

fn to_wit(&self) -> Result<WitAppliedEdit, String>

fn from_wit(w: WitAppliedEdit) -> Result<Self, String>

impl WitBoundary for AppliedEdit

type Wit = EventAppliedEdit

fn to_wit(&self) -> Result<WitEventAppliedEdit, String>

fn from_wit(wit: WitEventAppliedEdit) -> Result<Self, String>

impl WitBoundary for ArgDefault

type Wit = ArgDefault

fn to_wit(&self) -> Result<WitArgDefault, String>

fn from_wit(wit: WitArgDefault) -> Result<Self, String>

impl WitBoundary for ArgKind

type Wit = ArgKind

fn to_wit(&self) -> Result<WitArgKind, String>

fn from_wit(wit: WitArgKind) -> Result<Self, String>

impl WitBoundary for ArgSpec

type Wit = ArgSpec

fn to_wit(&self) -> Result<WitArgSpec, String>

fn from_wit(wit: WitArgSpec) -> Result<Self, String>

impl WitBoundary for ArgValue

type Wit = ArgValue

fn to_wit(&self) -> Result<WitArgValue, String>

fn from_wit(wit: WitArgValue) -> Result<Self, String>

impl WitBoundary for Args

type Wit = Args

fn to_wit(&self) -> Result<WitArgs, String>

fn from_wit(wit: WitArgs) -> Result<Self, String>

impl WitBoundary for CandidateData

type Wit = CandidateData

fn to_wit(&self) -> Result<WitCandidateData, String>

fn from_wit(wit: WitCandidateData) -> Result<Self, String>

impl WitBoundary for CandidateKind

type Wit = CandidateKind

fn to_wit(&self) -> Result<WitCandidateKind, String>

fn from_wit(wit: WitCandidateKind) -> Result<Self, String>

impl WitBoundary for ContextScope

type Wit = ContextScope

fn to_wit(&self) -> Result<WitContextScope, String>

fn from_wit(wit: WitContextScope) -> Result<Self, String>

impl WitBoundary for EchoLevel

type Wit = EchoLevel

fn to_wit(&self) -> Result<WitEchoLevel, String>

fn from_wit(w: WitEchoLevel) -> Result<Self, String>

impl WitBoundary for Edit

type Wit = Edit

fn to_wit(&self) -> Result<WitEdit, String>

fn from_wit(w: WitEdit) -> Result<Self, String>

impl WitBoundary for EditDelta

type Wit = EditDelta

fn to_wit(&self) -> Result<WitEditDelta, String>

fn from_wit(w: WitEditDelta) -> Result<Self, String>

impl WitBoundary for EditKind

type Wit = EditKind

fn to_wit(&self) -> Result<WitEditKind, String>

fn from_wit(w: WitEditKind) -> Result<Self, String>

impl WitBoundary for Effect

type Wit = Vec<Effect>

Effect is recursive (Many(Vec<Effect>)), which WIT value types cannot express. The boundary crosses a list<effect> instead: a single effect is a one-element list, and Many (associative composition) is flattened. from_wit rebuilds Many when the list has more than one element; an empty list is Effect::None. A single-element Many([x]) therefore normalises to x — a semantic identity, since Many([x]) ≡ x.

fn to_wit(&self) -> Result<Vec<WitEffect>, String>

fn from_wit(wit: Vec<WitEffect>) -> Result<Self, String>

impl WitBoundary for Event

fn to_wit(&self) -> Result<WitEvent, String>

Compiler-exhaustive: a new Event arm forces a mapping here. Ids cross as u64 (.raw()); paths via path_to_wit (non-UTF-8 → typed error).

type Wit = Event

fn from_wit(wit: WitEvent) -> Result<Self, String>

impl WitBoundary for EventKind

type Wit = EventKind

fn to_wit(&self) -> Result<WitEventKind, String>

fn from_wit(wit: WitEventKind) -> Result<Self, String>

impl WitBoundary for GutterDecoration

fn to_wit(&self) -> Result<WitGutterDecoration, String>

SG.4b: every native decoration is a Sign now, and a sign carries an interned id whose NAME only the registry knows. This context-free conversion does not have one, so both directions refuse by naming the registry-aware pair rather than dropping the placement.

The impl is kept rather than deleted because it is what makes that refusal a compiler-checked total function: a future arm still has to decide here, and “needs a registry” is a decision worth being told about rather than discovered as a missing glyph.

type Wit = GutterDecoration

fn from_wit(wit: WitGutterDecoration) -> Result<Self, String>

impl WitBoundary for GutterDiffKind

type Wit = GutterDiffKind

fn to_wit(&self) -> Result<WitGutterDiffKind, String>

fn from_wit(wit: WitGutterDiffKind) -> Result<Self, String>

impl WitBoundary for GutterSeverityLevel

type Wit = GutterSeverityLevel

fn to_wit(&self) -> Result<WitGutterSeverityLevel, String>

fn from_wit(wit: WitGutterSeverityLevel) -> Result<Self, String>

impl WitBoundary for HScroll

type Wit = Hscroll

fn to_wit(&self) -> Result<WitHscroll, String>

fn from_wit(w: WitHscroll) -> Result<Self, String>

impl WitBoundary for InsertLineEdit

type Wit = InsertLineEdit

fn to_wit(&self) -> Result<WitInsertLineEdit, String>

fn from_wit(w: WitInsertLineEdit) -> Result<Self, String>

impl WitBoundary for KeyChord

type Wit = KeyChord

fn to_wit(&self) -> Result<WitKeyChord, String>

fn from_wit(wit: WitKeyChord) -> Result<Self, String>

impl WitBoundary for LatencyClass

Intern a plugin-supplied owned string as &'static str. SurfaceForm’s

type Wit = LatencyClass

fn to_wit(&self) -> Result<WitLatencyClass, String>

fn from_wit(wit: WitLatencyClass) -> Result<Self, String>

impl WitBoundary for LspRequest

type Wit = LspRequest

fn to_wit(&self) -> Result<WitLspRequest, String>

fn from_wit(w: WitLspRequest) -> Result<Self, String>

impl WitBoundary for ModalState

type Wit = ModalState

fn to_wit(&self) -> Result<WitModalState, String>

fn from_wit(w: WitModalState) -> Result<Self, String>

impl WitBoundary for MotionResult

type Wit = MotionResult

fn to_wit(&self) -> Result<WitMotionResult, String>

fn from_wit(wit: WitMotionResult) -> Result<Self, String>

impl WitBoundary for OpenTarget

type Wit = OpenTarget

fn to_wit(&self) -> Result<WitOpenTarget, String>

fn from_wit(wit: WitOpenTarget) -> Result<Self, String>

impl WitBoundary for PaneDirection

type Wit = PaneDirection

fn to_wit(&self) -> Result<WitPaneDirection, String>

fn from_wit(w: WitPaneDirection) -> Result<Self, String>

impl WitBoundary for PickerAcceptOutcome

type Wit = PickerAcceptOutcome

fn to_wit(&self) -> Result<WitPickerAcceptOutcome, String>

fn from_wit(wit: WitPickerAcceptOutcome) -> Result<Self, String>

impl WitBoundary for PickerSourceSpec

type Wit = PickerSourceSpec

fn to_wit(&self) -> Result<WitPickerSourceSpec, String>

fn from_wit(wit: WitPickerSourceSpec) -> Result<Self, String>

impl WitBoundary for Position

type Wit = Position

fn to_wit(&self) -> Result<WitPosition, String>

fn from_wit(w: WitPosition) -> Result<Self, String>

impl WitBoundary for QuitScope

type Wit = QuitScope

fn to_wit(&self) -> Result<WitQuitScope, String>

fn from_wit(w: WitQuitScope) -> Result<Self, String>

impl WitBoundary for Range

type Wit = Range

fn to_wit(&self) -> Result<WitRange, String>

fn from_wit(w: WitRange) -> Result<Self, String>

impl WitBoundary for RawCandidate

type Wit = RawCandidate

fn to_wit(&self) -> Result<WitRawCandidate, String>

fn from_wit(wit: WitRawCandidate) -> Result<Self, String>

impl WitBoundary for Register

type Wit = Register

fn to_wit(&self) -> Result<WitRegister, String>

fn from_wit(w: WitRegister) -> Result<Self, String>

impl WitBoundary for RoutingPayload

type Wit = RoutingPayload

fn to_wit(&self) -> Result<WitRoutingPayload, String>

fn from_wit(wit: WitRoutingPayload) -> Result<Self, String>

impl WitBoundary for ScrollPos

type Wit = ScrollPos

fn to_wit(&self) -> Result<WitScrollPos, String>

fn from_wit(w: WitScrollPos) -> Result<Self, String>

impl WitBoundary for SearchDirection

type Wit = SearchDirection

fn to_wit(&self) -> Result<WitSearchDirection, String>

fn from_wit(w: WitSearchDirection) -> Result<Self, String>

impl WitBoundary for Selection

type Wit = Selection

fn to_wit(&self) -> Result<WitSelection, String>

fn from_wit(w: WitSelection) -> Result<Self, String>

impl WitBoundary for SelectionSet

type Wit = SelectionSet

fn to_wit(&self) -> Result<WitSelectionSet, String>

fn from_wit(w: WitSelectionSet) -> Result<Self, String>

impl WitBoundary for SpecialKey

type Wit = SpecialKey

fn to_wit(&self) -> Result<WitSpecialKey, String>

fn from_wit(wit: WitSpecialKey) -> Result<Self, String>

impl WitBoundary for SubstituteScope

type Wit = SubstituteScope

fn to_wit(&self) -> Result<WitSubstituteScope, String>

fn from_wit(w: WitSubstituteScope) -> Result<Self, String>

impl WitBoundary for SurfaceForm

type Wit = SurfaceForm

fn to_wit(&self) -> Result<WitSurfaceForm, String>

fn from_wit(wit: WitSurfaceForm) -> Result<Self, String>

impl WitBoundary for Utf16Pos

type Wit = Utf16Pos

fn to_wit(&self) -> Result<WitUtf16Pos, String>

fn from_wit(w: WitUtf16Pos) -> Result<Self, String>

impl WitBoundary for ViewportPos

type Wit = ViewportPos

fn to_wit(&self) -> Result<WitViewportPos, String>

fn from_wit(w: WitViewportPos) -> Result<Self, String>

impl WitBoundary for VisualKind

type Wit = VisualKind

fn to_wit(&self) -> Result<WitVisualKind, String>

fn from_wit(w: WitVisualKind) -> Result<Self, String>

impl WitBoundary for VisualMode

type Wit = VisualMode

fn to_wit(&self) -> Result<WitVisualMode, String>

fn from_wit(w: WitVisualMode) -> Result<Self, String>

impl WitBoundary for YankKind

type Wit = YankKind

fn to_wit(&self) -> Result<WitYankKind, String>

fn from_wit(w: WitYankKind) -> Result<Self, String>

Implementors