rcpp_hdf5_close_at_paths

OTHER

1 Description

Scans the live-pointer registry for any open hdf5Dataset objects that match the given filename and any of the paths. Each matching object is closed and its external pointer cleared, so that any R6 HDF5Matrix objects holding those pointers will return FALSE from is_valid() immediately.

This is called automatically by R6 methods that use overwrite = TRUE (e.g. $eigen(), $svd(), $qr(), $chol(), $prcomp()) to ensure that previous result objects are safely invalidated before the HDF5 datasets they reference are deleted and recreated.

2 Usage

rcpp_hdf5_close_at_paths(filename, paths)

3 Arguments

Parameter	Description
`filename`	Canonical filesystem path to the HDF5 file.
`paths`	Character vector of HDF5-internal paths (e.g. ).

4 Value

invisibly.

---
title: "rcpp_hdf5_close_at_paths"
subtitle: "rcpp_hdf5_close_at_paths"
---

<span class="category-badge other">OTHER</span>

## Description

Scans the live-pointer registry for any open `hdf5Dataset` objects
that match the given `filename` and any of the `paths`.
Each matching object is closed and its external pointer cleared, so
that any R6 `HDF5Matrix` objects holding those pointers will
return `FALSE` from `is_valid()` immediately.

This is called automatically by R6 methods that use
`overwrite = TRUE` (e.g. `$eigen()`, `$svd()`,
`$qr()`, `$chol()`, `$prcomp()`) to ensure that
previous result objects are safely invalidated before the HDF5 datasets
they reference are deleted and recreated.

## Usage

```r
rcpp_hdf5_close_at_paths(filename, paths)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `filename` | Canonical filesystem path to the HDF5 file. |
| `paths` | Character vector of HDF5-internal paths   (e.g. \code{c("EIGEN/sym/values", "EIGEN/sym/vectors")}).  |
:::

## Value

::: {.return-value}
\code{NULL} invisibly.

:::