pub enum ProtocolIr {
Call,
Http,
Cron,
Queue {
name: String,
},
WebSocket {
in_ty: TyId,
out_ty: TyId,
},
Events {
event: TyId,
pattern: Option<EventPatternIr>,
schema_dispatch: Option<i64>,
},
}Expand description
P6.11’s real ProtocolIr ([DECISION A], #1171) — one variant per
bynk_syntax::ast::ServiceProtocol variant, bynk_lower::lower_protocol_ir’s
own return value. The reference’s own sketch specifies only two of the
six: Events { event, pattern, schema_dispatch }
(bynk-greenfield-compiler.md:1881) and WebSocket { in_ty, out_ty }
(:1959) — field names taken verbatim from those two rows. Call/
Http/Cron carry no payload, not because one was dropped: the actual
per-trigger binding (a route, a schedule) lives on each handler
(HandlerKind::Http { method, path }/Cron { expr }), already
reachable through IrHandler::kind — ServiceProtocol’s own doc
comment says this in as many words (“the endpoint lives on each
handler”), which is why the reference never spells these three out
either. E2 (:1737) constrains the set, not the shape: “a closed
nominal set … grows one variant per real trigger” — the AST’s own closed
ServiceProtocol already satisfies that exactly, so this type is total
over what a certified program’s own service can declare, the same claim
StoreKindIr’s own doc makes about Queue being gated pre-certify.
Variants§
Call
Http
Cron
Queue
from queue("name").
WebSocket
from websocket(in: …, out: …) — the two frame types, resolved.
As of P6.13 (#1179), bynk_lower::lower_service_handler_ir lowers an
on open/on message/on close handler’s own body for a
service carrying this protocol too — see ConnectionBinder’s own
doc comment for how the synthetic connection binding reaches that
body’s scope.
Events
from Events(E) — the subscribed event type, resolved, plus the
two independent, optional filters a subscription may carry.
Fields
pattern: Option<EventPatternIr>schema_dispatch: Option<i64>P6.40 (design/tracks/the-ir.md §6a): flattened to Option<i64> —
SchemaVersionPattern has exactly one variant (Literal(i64)),
so once a real consumer needed to match on it
(emitter/emit.rs’s via schema(N) guard prologue), mirroring
the single-payload i64 directly was simpler than introducing a
one-variant IR-native enum purely to re-wrap it. A future range
pattern (via schema(2..)) widens this field’s own shape when it
lands, not before. The SchemaDispatch wrapper itself stays
dropped — it carried only this pattern plus a parse-only
span.
Trait Implementations§
Source§impl Clone for ProtocolIr
impl Clone for ProtocolIr
Source§fn clone(&self) -> ProtocolIr
fn clone(&self) -> ProtocolIr
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for ProtocolIr
impl RefUnwindSafe for ProtocolIr
impl Send for ProtocolIr
impl Sync for ProtocolIr
impl Unpin for ProtocolIr
impl UnsafeUnpin for ProtocolIr
impl UnwindSafe for ProtocolIr
Blanket Implementations§
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§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>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§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);