mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 21:17:01 +01:00
38 lines
7.7 KiB
HTML
38 lines
7.7 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Parse `Uuid`s from string literals at compile time."><meta name="keywords" content="rust, rustlang, rust-lang, uuid"><title>uuid in kanidmd_lib::prelude - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-8af5e100b21cd173.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-c55e1eb52e1886b4.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../kanidmd_lib/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../kanidmd_lib/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><div class="sidebar-elems"><h2><a href="index.html">In kanidmd_lib::prelude</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Macro <a href="../index.html">kanidmd_lib</a>::<wbr><a href="index.html">prelude</a>::<wbr><a class="macro" href="#">uuid</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="https://docs.rs/uuid/1.2.2/src/uuid/macros.rs.html#34-99">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><div class="item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules! </span>uuid {
|
||
(<span class="macro-nonterminal">$uuid</span>:literal) => { ... };
|
||
}</code></pre></div>
|
||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse <a href="https://docs.rs/uuid/*/uuid/struct.Uuid.html"><code>Uuid</code></a>s from string literals at compile time.</p>
|
||
<h3 id="usage"><a href="#usage">Usage</a></h3>
|
||
<p>This macro transforms the string literal representation of a
|
||
<a href="https://docs.rs/uuid/*/uuid/struct.Uuid.html"><code>Uuid</code></a> into the bytes representation, raising a compilation
|
||
error if it cannot properly be parsed.</p>
|
||
<h3 id="examples"><a href="#examples">Examples</a></h3>
|
||
<p>Setting a global constant:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub const </span>SCHEMA_ATTR_CLASS: Uuid = <span class="macro">uuid!</span>(<span class="string">"00000000-0000-0000-0000-ffff00000000"</span>);
|
||
<span class="kw">pub const </span>SCHEMA_ATTR_UUID: Uuid = <span class="macro">uuid!</span>(<span class="string">"00000000-0000-0000-0000-ffff00000001"</span>);
|
||
<span class="kw">pub const </span>SCHEMA_ATTR_NAME: Uuid = <span class="macro">uuid!</span>(<span class="string">"00000000-0000-0000-0000-ffff00000002"</span>);</code></pre></div>
|
||
<p>Defining a local variable:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>uuid = <span class="macro">uuid!</span>(<span class="string">"urn:uuid:F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4"</span>);</code></pre></div>
|
||
<h3 id="compilation-failures"><a href="#compilation-failures">Compilation Failures</a></h3>
|
||
<p>Invalid UUIDs are rejected:</p>
|
||
|
||
<div class="example-wrap compile_fail"><div class='tooltip'>ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">let </span>uuid = <span class="macro">uuid!</span>(<span class="string">"F9168C5E-ZEB2-4FAA-B6BF-329BF39FA1E4"</span>);</code></pre></div>
|
||
<p>Enable the feature <code>macro-diagnostics</code> to see the error messages below.</p>
|
||
<p>Provides the following compilation error:</p>
|
||
<div class="example-wrap"><pre class="language-txt"><code>error: invalid character: expected an optional prefix of `urn:uuid:` followed by 0123456789abcdefABCDEF-, found Z at 9
|
||
|
|
||
| let id = uuid!("F9168C5E-ZEB2-4FAA-B6BF-329BF39FA1E4");
|
||
| ^
|
||
</code></pre></div>
|
||
<p>Tokens that aren’t string literals are also rejected:</p>
|
||
|
||
<div class="example-wrap compile_fail"><div class='tooltip'>ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">let </span>uuid_str: <span class="kw-2">&</span>str = <span class="string">"550e8400e29b41d4a716446655440000"</span>;
|
||
<span class="kw">let </span>uuid = <span class="macro">uuid!</span>(uuid_str);</code></pre></div>
|
||
<p>Provides the following compilation error:</p>
|
||
<div class="example-wrap"><pre class="language-txt"><code>error: expected string literal
|
||
|
|
||
| let uuid = uuid!(uuid_str);
|
||
| ^^^^^^^^
|
||
</code></pre></div></div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="kanidmd_lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0 (fc594f156 2023-01-24)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html> |