You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
178 lines
8.8 KiB
178 lines
8.8 KiB
<!-- Generated by pkgdown: do not edit by hand -->
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Work With Filesystem Object Extended Attributes — xattrs • xattrs</title>
|
|
|
|
<!-- jquery -->
|
|
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
|
|
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
|
|
<!-- Font Awesome icons -->
|
|
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
|
|
|
|
<!-- clipboard.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../jquery.sticky-kit.min.js"></script>
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<meta property="og:title" content="Work With Filesystem Object Extended Attributes — xattrs" />
|
|
|
|
<meta property="og:description" content="Filesystem path target extended attributes store extra, customizable, small bits of
|
|
info. For example, author name, file character encoding, short comments, security
|
|
status, etc. Methods are provided to list, extract and work with these attributes." />
|
|
<meta name="twitter:card" content="summary" />
|
|
|
|
|
|
<!-- mathjax -->
|
|
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="container template-reference-topic">
|
|
<header>
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">xattrs</a>
|
|
<span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.1.0</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fa fa-home fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li>
|
|
<a href="https://github.com/hrbrmstr/xattrs">
|
|
<span class="fa fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Work With Filesystem Object Extended Attributes</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/xattrs/blob/master/R/xattrs-package.R'><code>R/xattrs-package.R</code></a></small>
|
|
<div class="hidden name"><code>xattrs.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
|
|
<p>Filesystem path target extended attributes store extra, customizable, small bits of
|
|
info. For example, author name, file character encoding, short comments, security
|
|
status, etc. Methods are provided to list, extract and work with these attributes.</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
|
|
<pre class="examples"><div class='input'><span class='co'># Create a temp file for the example</span>
|
|
<span class='no'>tf</span> <span class='kw'><-</span> <span class='fu'>tempfile</span>(<span class='kw'>fileext</span> <span class='kw'>=</span> <span class='st'>".csv"</span>)
|
|
<span class='fu'>write.csv</span>(<span class='no'>mtcars</span>, <span class='no'>tf</span>)
|
|
|
|
<span class='co'># has attributes? (shld be FALSE)</span>
|
|
<span class='fu'><a href='has_xattrs.html'>has_xattrs</a></span>(<span class='no'>tf</span>)</div><div class='output co'>#> [1] FALSE</div><div class='input'><span class='fu'><a href='get_xattr.html'>get_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting"</span>)</div><div class='output co'>#> character(0)</div><div class='input'>
|
|
<span class='co'># set an attribute</span>
|
|
<span class='fu'><a href='set_xattr.html'>set_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.a"</span>, <span class='st'>"first attribut"</span>)
|
|
<span class='fu'><a href='get_xattr.html'>get_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.a"</span>)</div><div class='output co'>#> [1] "first attribut"</div><div class='input'><span class='fu'><a href='get_xattr_size.html'>get_xattr_size</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.a"</span>)</div><div class='output co'>#> [1] 14</div><div class='input'>
|
|
<span class='co'># shld be TRUE</span>
|
|
<span class='fu'><a href='has_xattrs.html'>has_xattrs</a></span>(<span class='no'>tf</span>)</div><div class='output co'>#> [1] TRUE</div><div class='input'>
|
|
<span class='fu'><a href='set_xattr.html'>set_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.b"</span>, <span class='st'>"second attribute"</span>)
|
|
<span class='fu'><a href='get_xattr.html'>get_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.b"</span>)</div><div class='output co'>#> [1] "second attribute"</div><div class='input'><span class='fu'><a href='get_xattr_size.html'>get_xattr_size</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.b"</span>)</div><div class='output co'>#> [1] 16</div><div class='input'>
|
|
<span class='co'># overwrite an attribute</span>
|
|
<span class='fu'><a href='set_xattr.html'>set_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.a"</span>, <span class='st'>"first attribute"</span>)
|
|
<span class='fu'><a href='get_xattr.html'>get_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.a"</span>)</div><div class='output co'>#> [1] "first attribute"</div><div class='input'><span class='fu'><a href='get_xattr_size.html'>get_xattr_size</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting.a"</span>)</div><div class='output co'>#> [1] 15</div><div class='input'>
|
|
<span class='co'># see all the attributes</span>
|
|
<span class='fu'><a href='list_xattrs.html'>list_xattrs</a></span>(<span class='no'>tf</span>)</div><div class='output co'>#> [1] "is.rud.setting.a" "is.rud.setting.b"</div><div class='input'>
|
|
<span class='co'># data frame vs individual functions</span>
|
|
<span class='fu'><a href='get_xattr_df.html'>get_xattr_df</a></span>(<span class='no'>tf</span>)</div><div class='output co'>#> # A tibble: 2 x 3
|
|
#> name size contents
|
|
#> <chr> <dbl> <list>
|
|
#> 1 is.rud.setting.a 15 <raw [15]>
|
|
#> 2 is.rud.setting.b 16 <raw [16]></div><div class='input'>
|
|
<span class='co'># remove attribute</span>
|
|
<span class='fu'><a href='rm_xattr.html'>rm_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting"</span>)
|
|
<span class='fu'><a href='get_xattr.html'>get_xattr</a></span>(<span class='no'>tf</span>, <span class='st'>"is.rud.setting"</span>)</div><div class='output co'>#> character(0)</div><div class='input'>
|
|
<span class='co'># cleanup</span>
|
|
<span class='fu'>unlink</span>(<span class='no'>tf</span>)</div></pre>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
|
|
<h2>Contents</h2>
|
|
<ul class="nav nav-pills nav-stacked">
|
|
|
|
<li><a href="#examples">Examples</a></li>
|
|
</ul>
|
|
|
|
<h2>Author</h2>
|
|
|
|
Bob Rudis (bob@rud.is)
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p>Developed by Bob Rudis, Brandon Fosdick.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|