pub struct ApiOwnedView(/* private fields */);Expand description
Self-contained, 'static owned view of a Api message.
Wraps ::buffa::OwnedView<ApiView<'static>>: the decoded view and the ::buffa::bytes::Bytes buffer it borrows from travel together, so the handle is 'static and Send + Sync — suitable for async handlers, spawned tasks, and anywhere a 'static bound is required.
Field accessors return borrows tied to &self. Use Self::view to get the full ApiView when you need struct patterns, iteration helpers, or to pass the view to lifetime-parameterised code.
Implementations§
Source§impl ApiOwnedView
impl ApiOwnedView
Sourcepub fn decode(bytes: Bytes) -> Result<Self, DecodeError>
pub fn decode(bytes: Bytes) -> Result<Self, DecodeError>
Decode an owned view from a ::buffa::bytes::Bytes buffer.
The view borrows directly from the buffer’s data; the buffer is retained inside the returned handle.
§Errors
Returns ::buffa::DecodeError if the buffer contains invalid
protobuf data.
Sourcepub fn decode_with_options(
bytes: Bytes,
opts: &DecodeOptions,
) -> Result<Self, DecodeError>
pub fn decode_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self, DecodeError>
Decode with custom ::buffa::DecodeOptions (recursion limit,
max message size).
§Errors
Returns ::buffa::DecodeError if the buffer is invalid or
exceeds the configured limits.
Sourcepub fn from_owned(msg: &Api) -> Result<Self, DecodeError>
pub fn from_owned(msg: &Api) -> Result<Self, DecodeError>
Build from an owned message via an encode → decode round-trip.
§Errors
Returns ::buffa::DecodeError::MessageTooLarge if the
message’s encoded size exceeds the 2 GiB protobuf limit, or
another ::buffa::DecodeError if the re-encoded bytes are
somehow invalid (should not happen for well-formed messages).
Sourcepub fn to_owned_message(&self) -> Api
pub fn to_owned_message(&self) -> Api
Convert to the owned message type.
Infallible: this type’s constructors wire-decode their
buffer, and a view produced by wire decoding always
converts. Delegates to ::buffa::OwnedView::to_owned_message,
whose contract also governs handles converted from a raw
::buffa::OwnedView.
Sourcepub fn into_bytes(self) -> Bytes
pub fn into_bytes(self) -> Bytes
Consume the handle, returning the underlying bytes buffer.
Sourcepub fn name(&self) -> &str
pub fn name(&self) -> &str
The fully qualified name of this interface, including package name followed by the interface’s simple name.
Field 1: name
Sourcepub fn methods(&self) -> &RepeatedView<'_, MethodView<'_>>
pub fn methods(&self) -> &RepeatedView<'_, MethodView<'_>>
The methods of this interface, in unspecified order.
Field 2: methods
Sourcepub fn options(&self) -> &RepeatedView<'_, OptionView<'_>>
pub fn options(&self) -> &RepeatedView<'_, OptionView<'_>>
Any metadata attached to the interface.
Field 3: options
Sourcepub fn version(&self) -> &str
pub fn version(&self) -> &str
A version string for this interface. If specified, must have the form
major-version.minor-version, as in 1.10. If the minor version is
omitted, it defaults to zero. If the entire version field is empty, the
major version is derived from the package name, as outlined below. If the
field is not empty, the version in the package name will be verified to be
consistent with what is provided here.
The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.
The major version is also reflected in the package name of the
interface, which must end in v<major-version>, as in
google.feature.v1. For major versions 0 and 1, the suffix can
be omitted. Zero major versions must only be used for
experimental, non-GA interfaces.
Field 4: version
Sourcepub fn source_context(&self) -> &MessageFieldView<SourceContextView<'_>>
pub fn source_context(&self) -> &MessageFieldView<SourceContextView<'_>>
Source context for the protocol buffer service represented by this message.
Field 5: source_context
Sourcepub fn mixins(&self) -> &RepeatedView<'_, MixinView<'_>>
pub fn mixins(&self) -> &RepeatedView<'_, MixinView<'_>>
Included interfaces. See Mixin.
Field 6: mixins
Trait Implementations§
Source§impl Clone for ApiOwnedView
impl Clone for ApiOwnedView
Source§fn clone(&self) -> ApiOwnedView
fn clone(&self) -> ApiOwnedView
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more