<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A trait implemented by spans within a character-based source."><title>Span in ariadne - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="ariadne"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.2 (25ef9e3d8 2024-04-09)"data-channel="1.77.2"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../ariadne/index.html">ariadne</a><spanclass="version">0.4.0</span></h2></div><h2class="location"><ahref="#">Span</a></h2><divclass="sidebar-elems"><section><h3><ahref="#required-associated-types">Required Associated Types</a></h3><ulclass="block"><li><ahref="#associatedtype.SourceId">SourceId</a></li></ul><h3><ahref="#required-methods">Required Methods</a></h3><ulclass="block"><li><ahref="#tymethod.end">end</a></li><li><ahref="#tymethod.source">source</a></li><li><ahref="#tymethod.start">start</a></li></ul><h3><ahref="#provided-methods">Provided Methods</a></h3><ulclass="block"><li><ahref="#method.contains">contains</a></li><li><ahref="#method.len">len</a></li></ul><h3><ahref="#foreign-impls">Implementations on Foreign Types</a></h3><ulclass="block"><li><ahref="#impl-Span-for-(Id,+Range%3Cusize%3E)">(Id, Range<usize>)</a></li><li><ahref="#impl-Span-for-Range%3Cusize%3E">Range<usize></a></li></ul><h3><ahref="#object-safety">Object Safety</a></h3><h3><ahref="#implementors">Implementors</a></h3></section><h2><ahref="index.html">In crate ariadne</a></h2></div></nav><divclass="sidebar-resizer"></div>
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../ariadne/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Trait <ahref="index.html">ariadne</a>::<wbr><aclass="trait"href="#">Span</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/ariadne/lib.rs.html#29-53">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub trait Span {
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A trait implemented by spans within a character-based source.</p>
</div></details><h2id="required-associated-types"class="section-header">Required Associated Types<ahref="#required-associated-types"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle"open><summary><sectionid="associatedtype.SourceId"class="method"><aclass="src rightside"href="../src/ariadne/lib.rs.html#31">source</a><h4class="code-header">type <ahref="#associatedtype.SourceId"class="associatedtype">SourceId</a>: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/cmp/trait.PartialEq.html"title="trait core::cmp::PartialEq">PartialEq</a> + <aclass="trait"href="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> + ?<aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a></h4></section></summary><divclass="docblock"><p>The identifier used to uniquely refer to a source. In most cases, this is the fully-qualified path of the file.</p>
</div></details></div><h2id="required-methods"class="section-header">Required Methods<ahref="#required-methods"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.source"class="method"><aclass="src rightside"href="../src/ariadne/lib.rs.html#34">source</a><h4class="code-header">fn <ahref="#tymethod.source"class="fn">source</a>(&self) ->&Self::<aclass="associatedtype"href="trait.Span.html#associatedtype.SourceId"title="type ariadne::Span::SourceId">SourceId</a></h4></section></summary><divclass="docblock"><p>Get the identifier of the source that this span refers to.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.start"class="method"><aclass="src rightside"href="../src/ariadne/lib.rs.html#39">source</a><h4class="code-header">fn <ahref="#tymethod.start"class="fn">start</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Get the start offset of this span.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.end"class="method"><aclass="src rightside"href="../src/ariadne/lib.rs.html#46">source</a><h4class="code-header">fn <ahref="#tymethod.end"class="fn">end</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Get the (exclusive) end offset of this span.</p>
<p>The end offset should <em>always</em> be greater than or equal to the start offset as given by <ahref="trait.Span.html#tymethod.start"title="method ariadne::Span::start"><code>Span::start</code></a>.</p>
<p>Offsets are zero-indexed character offsets from the beginning of the source.</p>
</div></details></div><h2id="provided-methods"class="section-header">Provided Methods<ahref="#provided-methods"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle method-toggle"open><summary><sectionid="method.len"class="method"><aclass="src rightside"href="../src/ariadne/lib.rs.html#49">source</a><h4class="code-header">fn <ahref="#method.len"class="fn">len</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Get the length of this span (difference between the start of the span and the end of the span).</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.contains"class="method"><aclass="src rightside"href="../src/ariadne/lib.rs.html#52">source</a><h4class="code-header">fn <ahref="#method.contains"class="fn">contains</a>(&self, offset: <aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.usize.html">usize</a>) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Determine whether the span contains the given offset.</p>
