Struct FrameId 

pub struct FrameId(/* private fields */);

Identifier for a frame context.

Unlike TabId and SessionId, FrameId(0) is valid and represents the main (top-level) frame. Firefox frame IDs can be large 64-bit values for iframes.

Example

let main_frame = FrameId::main();
assert!(main_frame.is_main());
assert_eq!(main_frame.as_u64(), 0);

let iframe = FrameId::new(17179869185);
assert!(!iframe.is_main());

Implementations

impl FrameId

pub const fn new(id: u64) -> Self

Creates a new frame identifier.

pub const fn main() -> Self

Returns the main frame identifier (0).

pub const fn is_main(&self) -> bool

Returns true if this is the main frame.

pub const fn as_u64(&self) -> u64

Returns the underlying u64 value.

Trait Implementations

impl Clone for FrameId

fn clone(&self) -> FrameId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameId

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

Formats the value using the given formatter.

impl Default for FrameId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FrameId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FrameId

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

Formats the value using the given formatter.

impl From<u64> for FrameId

fn from(id: u64) -> Self

Converts to this type from the input type.

impl Hash for FrameId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FrameId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FrameId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FrameId

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for FrameId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FrameId

impl Eq for FrameId

impl StructuralPartialEq for FrameId