native::Fs(3)

📦 version 1.14.5, in nixpkgs unstable

🌸 NAME 🌸

Okay bestie, welcome to native::Fs(3) — it's from the User Contributed Perl Documentation corner of the universe, and it's literally the page for SVN::Fs — Subversion filesystem functions. 💖

✨ DESCRIPTION ✨

SVN::Fs wraps the functions in svn_fs.h. The actual namespace for filesystem objects is _p_svn_fs_t. No cap, that's the whole vibe check. 🫶

🧚 FUNCTIONS 🧚

Here's the full roster, bestie — no names skipped, no tea left out. 👑

  • SVN::Fs::berkeley_logfiles($path, $only_unused) — listed here, no extra blurb on this page.
  • SVN::Fs::berkeley_recover($path) — listed here, no extra blurb on this page.
  • SVN::Fs::check_related($id1, $id2) — listed here, no extra blurb on this page.
  • SVN::Fs::compare_ids($id1, $id2) — listed here, no extra blurb on this page.
  • SVN::Fs::contents_changed($root1, $path1, $root2, $path2) — listed here, no extra blurb on this page.
  • SVN::Fs::create($path, $config) — listed here, no extra blurb on this page.
  • SVN::Fs::delete_fs($path) — listed here, no extra blurb on this page.
  • SVN::Fs::deltify_revision($fs, $rev) — listed here, no extra blurb on this page.
  • SVN::Fs::get_file_delta_stream($source_root, $source_path, $target_root, $target_path) — listed here, no extra blurb on this page.
  • SVN::Fs::hotcopy($src_path, $dest_path, $clean) — listed here, no extra blurb on this page.
  • SVN::Fs::initialize($pool) — listed here, no extra blurb on this page.
  • SVN::Fs::merge($source_root, $source_path, $target_root, $target_path, $ancestor_root, $ancestor_path) — listed here, no extra blurb on this page.
  • SVN::Fs::open($path, $config) — listed here, no extra blurb on this page.
  • SVN::Fs::path($fs) — listed here, no extra blurb on this page.
  • SVN::Fs::print_modules($s) — okay so this one has a big honest TODO attached: doesn't work, segfaults if $s is null, doesn't do anything if its an empty string. 💀
  • SVN::Fs::props_changed($root1, $path1, $root2, $path2) — see also SVN::Fs::contents_changed.
  • SVN::Fs::purge_txn($fs, $txn_id) — cleanup the transaction $txn_id, removing it completely from the filesystem $fs.
  • SVN::Fs::set_warning_func($fs, $code, $baton) — listed here, no extra blurb on this page.
  • SVN::Fs::unparse_id($id) — return a string containing the unparsed form of the node or node revision id $id, which must be a _p_svn_fs_id_t object. Also: TODO — why isn't this a method of that object? 👀
  • SVN::Fs::version() — TODO — what can we do with the _p_svn_version_t value returned?
  • SVN::Fs::create_access($username) — return a new _p_svn_fs_access_t object representing $username. $username is presumed to have been authenticated by the caller. 🔐

🦋 _p_svn_fs_t 🦋

  • $fs->begin_txn($rev) — creates a new transaction in the repository, and returns a _p_svn_fs_txn_t object representing it. The new transaction's base revision will be $rev, which should be a number.
  • $fs->change_rev_prop — no extra description on this page, just vibing in the list.
  • $fs->generate_lock_token() — generate a unique lock-token using $fs. TODO — translate this to apply to Perl: This can be used in to populate lock->token before calling svn_fs_attach_lock(). 🔒
  • $fs->get_access() — the filesystem's current access context, as a _p_svn_fs_access_t object. Returns undef if no access context has been set with the set_access() method.
  • $fs->get_lock — no extra description on this page.
  • $fs->get_locks — no extra description on this page.
  • $fs->get_uuid() — the UUID associated with $fs.
  • $fs->list_transactions() — a reference to an array of all currently active transactions in the filesystem. Each one is a string containing the transaction's ID, suitable for passing to $fs->open_txn().
  • $fs->lock — no extra description on this page.
  • $fs->open_txn($name) — get a transaction in the repository by name. Returns a _p_svn_fs_txn_t object.
  • $fs->revision_prop($rev, $propname) — the value of revision property $propname in revision $rev.
  • $fs->revision_proplist($rev) — a hashref containing the names and values of all revision properties from revision $rev.
  • $fs->revision_root — no extra description on this page.
  • $fs->set_access($access) — associate an access context with an open filesystem. This method can be run multiple times on the same open filesystem, in order to change the filesystem access context for different filesystem operations. $access should be a _p_svn_fs_access_t object, or undef to disassociate the current access context from the filesystem.
  • $fs->set_uuid($uuid) — associate $uuid with $fs.
  • $fs->unlock — no extra description on this page.
  • $fs->youngest_rev() — return the number of the youngest revision in the filesystem. The oldest revision in any filesystem is numbered zero.

🌈 _p_svn_fs_root_t 🌈

  • $root->apply_text — no extra description on this page.
  • $root->apply_textdelta — no extra description on this page.
  • $root->change_node_prop($path, $propname, $value) — no extra description on this page.
  • $root->check_path($path) — kind of node at $path. A number which matches one of these constants: $SVN::Node::none, $SVN::Node::file, $SVN::Node::dir, $SVN::Node::unknown.
  • $root->close_root — no extra description on this page.
  • $root->closest_copy — no extra description on this page.
  • $root->copied_from — no extra description on this page.
  • $root->copy — no extra description on this page.
  • $root->delete — no extra description on this page.
  • $root->dir_entries — no extra description on this page.
  • $root->file_contents — no extra description on this page.
  • $root->file_length — no extra description on this page.
  • $root->file_md5_checksum — no extra description on this page.
  • $root->fs() — the filesystem to which $root belongs, as a _p_svn_fs_t object.
  • $root->is_dir($path) — true if there is a node at $path which is a directory.
  • $root->is_file($path) — true if there is a node at $path which is a file.
  • $root->is_revision_root() — true if the root comes from a revision (i.e., the contents has already been committed).
  • $root->is_txn_root() — true if the root comes from a transaction.
  • $root->make_dir — no extra description on this page.
  • $root->make_file — no extra description on this page.
  • $root->node_created_path($path) — no extra description on this page.
  • $root->node_created_rev($path) — no extra description on this page.
  • $root->node_history($path) — TODO — _p_svn_fs_history_t.
  • $root->node_id($path) — no extra description on this page.
  • $root->node_prop($path, $propname) — no extra description on this page.
  • $root->node_proplist($path) — no extra description on this page.
  • $root->paths_changed() — a reference to a hash indicating what changes are made in the root. The keys are the paths of the files changed, starting with / to indicate the top-level directory of the repository. The values are _p_svn_fs_path_change_t objects which contain information about what kind of changes are made.
  • $root->revision_link — no extra description on this page.
  • $root->revision_root_revision — revision number of the revision the root comes from. For transaction roots, returns $SVN::Core::INVALID_REVNUM.

🎀 _p_svn_fs_history_t 🎀

  • $history->location() — in list context, a list of two items: the path to the node whose history this is, and the revision number in which it exists. In scalar context returns only the revision number.
  • $history->prev($cross_copies) — no extra description on this page.

💅 _p_svn_fs_txn_t 💅

  • $txn->abort() — abort the transaction. Any changes made in $txn are discarded, and the filesystem is left unchanged.
Note: This function first sets the state of $txn to 'dead', and then attempts to purge it and any related data from the filesystem. If some part of the cleanup process fails, $txn and some portion of its data may remain in the database after this function returns. Use $fs->purge_txn() to retry the transaction cleanup.
  • $txn->base_revision() — the transaction's base revision number.
  • $txn->change_prop($name, $value) — add, change, or remove a property from the transaction. If $value is undef then the property $name is removed, if it exists. Otherwise the property $name is set to the new value.
  • $txn->commit — no extra description on this page.
  • $txn->name() — full name of the revision, in the same format as can be passed to $fs->open_txn().
  • $txn->prop($name) — the value of the transaction's $name property.
  • $txn->proplist() — a reference to a hash containing all the transaction's properties, keyed by name.
  • $txn->root() — the root directory of the transaction, as a _p_svn_fs_root_t object.

🌸 _p_svn_fs_access_t 🌸

🌈 SYNOPSIS 🌈

my $access = SVN::Fs::create_access($username);

my $access = $fs->get_access;
$fs->set_access($access);

my $username = $access->get_username;

$access->add_lock_token($token);

💅 METHODS 💅

  • $access->add_lock_token($token) — push a lock-token into the access context. The context remembers all tokens it receives, and makes them available to fs functions.
  • $access->get_username — the username represented by the access context.

🦋 svn_fs_dirent_t 🦋

An object representing a directory entry. Values of this type are returned as the values in the hash returned by $root->dir_entries(). They are like svn_dirent_t objects, but have less information.

  • $dirent->id() — TODO.
  • $dirent->kind() — node kind. A number which matches one of these constants: $SVN::Node::none, $SVN::Node::file, $SVN::Node::dir, $SVN::Node::unknown.
  • $dirent->name() — the filename of the directory entry.

⭐ _p_svn_fs_path_change_t ⭐

  • $change->change_kind() — the type of change made. A number which matches one of the following:
    • $SVN::Fs::PathChange::modify — content at path modified.
    • $SVN::Fs::PathChange::add — path added in transaction.
    • $SVN::Fs::PathChange::delete — path removed in transaction.
    • $SVN::Fs::PathChange::replace — path removed and re-added in transaction.
    • $SVN::Fs::PathChange::reset — ignore all previous change items for path (internal-use only).
  • $change->node_rev_id() — node revision id of changed path. A _p_svn_fs_id_t object.
  • $change->prop_mod() — true if the properties were modified.
  • $change->text_mod() — true if the text (content) was modified.

Okay legal bestie moment — here's the whole Apache text, unchanged and iconic:

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
💖 mwah! This page is from perl v5.42.3, dated 2024-11-27, and it's the native::Fs(3) footer signing off. Periodt. 🎀
📦 where this page comes from