Struct Performance 

pub struct Performance { /* private fields */ }

Firebase Performance Monitoring entry point tied to a FirebaseApp.

This struct intentionally mirrors the behaviour of the JS SDK’s FirebasePerformance controller: it holds runtime toggles, orchestrates trace/HTTP instrumentation, and can be retrieved via get_performance.

Implementations

impl Performance

pub fn app(&self) -> &FirebaseApp

Returns the FirebaseApp that owns this performance instance.

pub fn settings(&self) -> PerformanceRuntimeSettings

Resolves the currently effective runtime settings.

pub fn apply_settings(&self, settings: PerformanceSettings)

Applies the provided settings, overwriting only the Some fields.

pub fn set_data_collection_enabled(&self, enabled: bool)

Enables or disables manual/custom trace collection.

pub fn set_instrumentation_enabled(&self, enabled: bool)

Enables or disables automatic instrumentation (network/OOB traces).

pub fn data_collection_enabled(&self) -> bool

Returns whether manual/custom traces are currently recorded.

pub fn instrumentation_enabled(&self) -> bool

Returns whether automatic instrumentation (network/OOB) is enabled.

pub fn attach_app_check(&self, app_check: FirebaseAppCheckInternal)

Associates an App Check instance whose tokens will be attached to outgoing network trace records.

pub fn clear_app_check(&self)

Removes any App Check integration.

pub fn attach_auth(&self, auth: FirebaseAuth)

Associates a FirebaseAuth instance so recorded traces can capture the active user ID (mirrors the JS SDK’s setUserId).

pub fn set_authenticated_user_id(&self, uid: Option<&str>)

Manually overrides the authenticated user ID attribute that will be stored with subsequent traces.

pub fn clear_auth(&self)

Clears any stored authentication context.

pub fn new_trace(&self, name: &str) -> PerformanceResult<TraceHandle>

Creates a new manual trace. Call TraceHandle::start / stop to record the timing metrics.

Examples

let perf = get_performance(Some(app)).await?;
let mut trace = perf.new_trace("warmup")?;
trace.start()?;
let _ = trace.stop().await?;

pub fn new_network_request( &self, url: &str, method: HttpMethod, ) -> PerformanceResult<NetworkTraceHandle>

Creates a manual network trace, mirroring the JS SDK’s performance.traceNetworkRequest helper.

Examples

let perf = get_performance(Some(app)).await?;
let mut req = perf.new_network_request("https://example.com", HttpMethod::Get)?;
req.start()?;
let _record = req.stop().await?;

pub async fn recorded_trace(&self, name: &str) -> Option<PerformanceTrace>

Returns the most recently recorded trace with the provided name.

pub async fn recorded_network_request( &self, url: &str, ) -> Option<NetworkRequestRecord>

Returns the latest network trace captured for the given URL (without query parameters), if any.

pub fn configure_transport(&self, options: TransportOptions)

Overrides the transport configuration used for batching uploads.

pub async fn flush_transport(&self) -> PerformanceResult<()>

Forces an immediate transport flush.

Trait Implementations

impl Clone for Performance

fn clone(&self) -> Performance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Performance

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

Formats the value using the given formatter.