Skip to main content

ProtocolAbiVersion

Enum ProtocolAbiVersion 

Source
#[repr(i32)]
pub enum ProtocolAbiVersion { Unspecified = 0, V1 = 1, V2 = 2, }
Expand description

A shared memory layout and the operations that send its data to the service. The versions are independent: v2 does not imply v1. The producer sends a bitmask of its versions in InitializeConnectionRequest. The service returns the bitmask of common versions. This exchange does not select a writer for an instance.

Each value is a single bit, so a uint32 mask holds a set of versions. A new version must take the next unused bit: 4, then 8.

Keep in sync with ProtocolAbiVersion in include/perfetto/ext/tracing/core/tracing_service.h, which describes each version in detail.

Variants§

§

Unspecified = 0

Reserved. Do not advertise this value.

§

V1 = 1

The original protocol: a shared memory buffer (SMB) of pages and chunks, with CommitData IPCs and patches. Docs: https://perfetto.dev/docs/design-docs/api-and-abi#shmem-abi.

§

V2 = 2

Tracing v2: a ring buffer that the producer allocates, shared with AttachV2RingBuffer and read on DrainV2RingBuffer. It is experimental and its ABI is not stable yet. Design: RFC-0014, https://github.com/google/perfetto/discussions/4508.

Implementations§

Source§

impl ProtocolAbiVersion

Source

pub const fn is_valid(value: i32) -> bool

Returns true if value is a variant of ProtocolAbiVersion.

Source

pub fn from_i32(value: i32) -> Option<ProtocolAbiVersion>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a ProtocolAbiVersion, or None if value is not a valid variant.

Source§

impl ProtocolAbiVersion

Source

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

Source

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations§

Source§

impl Clone for ProtocolAbiVersion

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for ProtocolAbiVersion

Source§

impl Debug for ProtocolAbiVersion

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ProtocolAbiVersion

Source§

fn default() -> ProtocolAbiVersion

Returns the “default value” for a type. Read more
Source§

impl Eq for ProtocolAbiVersion

Source§

impl From<ProtocolAbiVersion> for i32

Source§

fn from(value: ProtocolAbiVersion) -> i32

Converts to this type from the input type.
Source§

impl Hash for ProtocolAbiVersion

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ProtocolAbiVersion

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for ProtocolAbiVersion

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PartialOrd for ProtocolAbiVersion

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for ProtocolAbiVersion

Source§

impl TryFrom<i32> for ProtocolAbiVersion

Source§

type Error = UnknownEnumValue

The type returned in the event of a conversion error.
Source§

fn try_from(value: i32) -> Result<ProtocolAbiVersion, UnknownEnumValue>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.