remove_directory_cnt: Remove a directory

View source: R/cnt_generics.R

remove_directory_cntR Documentation

Remove a directory

Description

Generic implementing of how to remove a directory for a connector. Mostly relevant for file storage connectors.

  • ConnectorFS: Uses fs::dir_delete() to remove a directory at the path of the connector.

Usage

remove_directory_cnt(connector_object, name, ...)

## S3 method for class 'ConnectorFS'
remove_directory_cnt(connector_object, name, ...)

Arguments

connector_object

Connector The connector object to use.

name

character The name of the directory to remove

...

Additional arguments passed to the method for the individual connector.

Value

invisible connector_object.

Examples

# Remove a directory from a file storage

folder <- withr::local_tempdir()
cnt <- connector_fs(folder)

cnt |>
  create_directory_cnt("new_folder")

cnt |>
  list_content_cnt(pattern = "new_folder")

cnt |>
  remove_directory_cnt("new_folder") |>
  list_content_cnt(pattern = "new_folder")


connector documentation built on June 8, 2025, 11:36 a.m.