Skip to contents

Generates a report of active shared memory segments in the current session.

Usage

segment_report()

Value

An S3 object of class shard_report with type "segment" containing:

  • type: "segment"

  • timestamp: When the report was generated

  • n_segments: Number of tracked segments

  • total_bytes: Total bytes across all segments

  • segments: List of segment details

Details

This function reports on segments that are currently accessible. Note that segments are automatically cleaned up when their R objects are garbage collected, so this only shows segments with live references.

Examples

# \donttest{
segment_report()
#> shard segment report
#> Generated: 2026-03-30 20:47:46 
#> 
#> Backing types:
#>   Available: mmap, shm 
#>   Platform: unix 
#>   Windows: FALSE 
# }