Struct Local 

pub struct Local;

Marker type indicating that a report is not Send or Sync.

This marker is used when a report contains thread-local data that cannot be safely sent between threads or shared across threads. Common examples include Rc, raw pointers, or types that explicitly opt out of Send/Sync.

When to Use

Use Local when your error context or attachments contain:

• Rc<T> or Weak<T> (use Arc<T> for thread-safe alternative)
• Raw pointers (*const T, *mut T)
• Types that wrap thread-local storage
• Any type that is !Send or !Sync

Converting to Local

You can convert a thread-safe report to a local one using into_local, or create a local report directly when the context type is not Send + Sync.

Examples

use std::rc::Rc;

use rootcause::prelude::*;

// Rc is not Send or Sync, so the report must be Local
let local_data: Rc<String> = Rc::new("Thread-local error".to_string());
let report: Report<Rc<String>, markers::Mutable, markers::Local> = report!(local_data);

// This report cannot be sent to another thread
// std::thread::spawn(move || {
//     println!("{}", report); // ❌ Won't compile
// });

Converting a thread-safe report to local:

use std::rc::Rc;

use rootcause::prelude::*;

let report: Report<String> = report!("Error".to_string());

// Convert to local report so we can use thread-local data
let local_report: Report<String, markers::Mutable, markers::Local> = report.into_local();

Trait Implementations

impl Clone for Local

fn clone(&self) -> Local

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Local

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

Formats the value using the given formatter.

impl Default for Local

fn default() -> Local

Returns the “default value” for a type.

impl Hash for Local

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<C: ?Sized, O, T> IntoReport<Local> for Report<C, O, T>

type Context = C

The context type of the resulting report.

type Ownership = O

The ownership marker of the resulting report.

fn into_report(self) -> Report<Self::Context, Self::Ownership, Local>

Converts self into a Report with the specified thread-safety marker.

impl<C, O, T> IntoReportCollection<Local> for Report<C, O, T>

where C: ?Sized, O: ReportOwnershipMarker,

type Context = C

The context type of the resulting report collection.

fn into_report_collection(self) -> ReportCollection<Self::Context, Local>

Converts self into a ReportCollection with the specified thread-safety marker.

impl<C, T> IntoReportCollection<Local> for ReportCollection<C, T>

where C: ?Sized,

type Context = C

The context type of the resulting report collection.

fn into_report_collection(self) -> ReportCollection<Self::Context, Local>

Converts self into a ReportCollection with the specified thread-safety marker.

impl Ord for Local

fn cmp(&self, other: &Local) -> 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 Local

fn eq(&self, other: &Local) -> 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 Local

fn partial_cmp(&self, other: &Local) -> 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 Copy for Local

impl Eq for Local

impl StructuralPartialEq for Local