50 lines
No EOL
20 KiB
HTML
50 lines
No EOL
20 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="Trait for trying to cast a reference to collection of color components into a reference to collection of colors without copying."><title>TryComponentsAs in cosmic::cosmic_theme::palette::cast - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../static.files/storage-68b7e25d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">TryComponents<wbr>As</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#errors" title="Errors">Errors</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.try_components_as" title="try_components_as">try_components_as</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TryComponentsAs%3C%5BC%5D%3E-for-%5BT;+M%5D" title="[T; M]">[T; M]</a></li><li><a href="#impl-TryComponentsAs%3C%5BC%5D%3E-for-%5BT%5D" title="[T]">[T]</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cosmic_<wbr>theme::<wbr>palette::<wbr>cast</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">cosmic</a>::<wbr><a href="../../index.html">cosmic_theme</a>::<wbr><a href="../index.html">palette</a>::<wbr><a href="index.html">cast</a></div><h1>Trait <span class="trait">TryComponentsAs</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#127">Source</a> </span></div><pre class="rust item-decl"><code>pub trait TryComponentsAs<C><div class="where">where
|
||
C: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div>{
|
||
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
||
|
||
// Required method
|
||
fn <a href="#tymethod.try_components_as" class="fn">try_components_as</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&C</a>, Self::<a class="associatedtype" href="trait.TryComponentsAs.html#associatedtype.Error" title="type cosmic::cosmic_theme::palette::cast::TryComponentsAs::Error">Error</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for trying to cast a reference to collection of color components into
|
||
a reference to collection of colors without copying.</p>
|
||
<p>This trait is meant as a more convenient alternative to the free functions
|
||
in <a href="index.html" title="mod cosmic::cosmic_theme::palette::cast"><code>cast</code></a>, to allow method chaining among other things.</p>
|
||
<h3 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h3>
|
||
<p>The cast will return an error if the cast fails, such as when the length of
|
||
the input is not a multiple of the color’s array length.</p>
|
||
<h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>palette::{cast::TryComponentsAs, Srgb};
|
||
|
||
<span class="kw">let </span>array: [<span class="kw">_</span>; <span class="number">6</span>] = [<span class="number">64</span>, <span class="number">139</span>, <span class="number">10</span>, <span class="number">93</span>, <span class="number">18</span>, <span class="number">214</span>];
|
||
<span class="kw">let </span>slice: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="number">64</span>, <span class="number">139</span>, <span class="number">10</span>, <span class="number">93</span>, <span class="number">18</span>, <span class="number">214</span>];
|
||
<span class="kw">let </span>vec: Vec<<span class="kw">_</span>> = <span class="macro">vec!</span>[<span class="number">64</span>, <span class="number">139</span>, <span class="number">10</span>, <span class="number">93</span>, <span class="number">18</span>, <span class="number">214</span>];
|
||
|
||
<span class="kw">let </span>colors: <span class="prelude-ty">Result</span><<span class="kw-2">&</span>[Srgb<u8>], <span class="kw">_</span>> = array.try_components_as();
|
||
<span class="macro">assert_eq!</span>(colors, <span class="prelude-val">Ok</span>(<span class="kw-2">&</span>[Srgb::new(<span class="number">64u8</span>, <span class="number">139</span>, <span class="number">10</span>), Srgb::new(<span class="number">93</span>, <span class="number">18</span>, <span class="number">214</span>)][..]));
|
||
|
||
<span class="kw">let </span>colors: <span class="prelude-ty">Result</span><<span class="kw-2">&</span>[Srgb<u8>], <span class="kw">_</span>> = slice.try_components_as();
|
||
<span class="macro">assert_eq!</span>(colors, <span class="prelude-val">Ok</span>(<span class="kw-2">&</span>[Srgb::new(<span class="number">64u8</span>, <span class="number">139</span>, <span class="number">10</span>), Srgb::new(<span class="number">93</span>, <span class="number">18</span>, <span class="number">214</span>)][..]));
|
||
|
||
<span class="kw">let </span>colors: <span class="prelude-ty">Result</span><<span class="kw-2">&</span>[Srgb<u8>], <span class="kw">_</span>> = vec.try_components_as();
|
||
<span class="macro">assert_eq!</span>(colors, <span class="prelude-val">Ok</span>(<span class="kw-2">&</span>[Srgb::new(<span class="number">64u8</span>, <span class="number">139</span>, <span class="number">10</span>), Srgb::new(<span class="number">93</span>, <span class="number">18</span>, <span class="number">214</span>)][..]));</code></pre></div>
|
||
<p>This produces an error:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>palette::{cast::TryComponentsAs, Srgb};
|
||
|
||
<span class="kw">let </span>components = [<span class="number">64</span>, <span class="number">139</span>, <span class="number">10</span>, <span class="number">93</span>, <span class="number">18</span>]; <span class="comment">// Not a multiple of 3
|
||
</span><span class="kw">let </span>colors: <span class="prelude-ty">Result</span><<span class="kw-2">&</span>[Srgb<u8>], <span class="kw">_</span>> = components.try_components_as();
|
||
<span class="macro">assert!</span>(colors.is_err());</code></pre></div>
|
||
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#129">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></summary><div class="docblock"><p>The error for when <code>try_components_as</code> fails to cast.</p>
|
||
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.try_components_as" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#137">Source</a><h4 class="code-header">fn <a href="#tymethod.try_components_as" class="fn">try_components_as</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&C</a>, Self::<a class="associatedtype" href="trait.TryComponentsAs.html#associatedtype.Error" title="type cosmic::cosmic_theme::palette::cast::TryComponentsAs::Error">Error</a>></h4></section></summary><div class="docblock"><p>Try to cast this collection of color components into a reference to a
|
||
collection of colors.</p>
|
||
<p>Return an error if the conversion can’t be done, such as when the number
|
||
of items in <code>self</code> isn’t a multiple of the number of components in the
|
||
color type.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-TryComponentsAs%3C%5BC%5D%3E-for-%5BT%5D" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#222">Source</a><a href="#impl-TryComponentsAs%3C%5BC%5D%3E-for-%5BT%5D" class="anchor">§</a><h3 class="code-header">impl<'a, T, C, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.TryComponentsAs.html" title="trait cosmic::cosmic_theme::palette::cast::TryComponentsAs">TryComponentsAs</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[T]</a><div class="where">where
|
||
C: <a class="trait" href="trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#222">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.SliceCastError.html" title="struct cosmic::cosmic_theme::palette::cast::SliceCastError">SliceCastError</a></h4></section><section id="method.try_components_as" class="method trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#222">Source</a><a href="#method.try_components_as" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.try_components_as" class="fn">try_components_as</a>(
|
||
&self,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>, <<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[T]</a> as <a class="trait" href="trait.TryComponentsAs.html" title="trait cosmic::cosmic_theme::palette::cast::TryComponentsAs">TryComponentsAs</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>>>::<a class="associatedtype" href="trait.TryComponentsAs.html#associatedtype.Error" title="type cosmic::cosmic_theme::palette::cast::TryComponentsAs::Error">Error</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryComponentsAs%3C%5BC%5D%3E-for-%5BT;+M%5D" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#222">Source</a><a href="#impl-TryComponentsAs%3C%5BC%5D%3E-for-%5BT;+M%5D" class="anchor">§</a><h3 class="code-header">impl<'a, T, C, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, const M: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.TryComponentsAs.html" title="trait cosmic::cosmic_theme::palette::cast::TryComponentsAs">TryComponentsAs</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; M]</a><div class="where">where
|
||
C: <a class="trait" href="trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#222">Source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.SliceCastError.html" title="struct cosmic::cosmic_theme::palette::cast::SliceCastError">SliceCastError</a></h4></section><section id="method.try_components_as-1" class="method trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#222">Source</a><a href="#method.try_components_as-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.try_components_as" class="fn">try_components_as</a>(
|
||
&self,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>, <<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; M]</a> as <a class="trait" href="trait.TryComponentsAs.html" title="trait cosmic::cosmic_theme::palette::cast::TryComponentsAs">TryComponentsAs</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>>>::<a class="associatedtype" href="trait.TryComponentsAs.html#associatedtype.Error" title="type cosmic::cosmic_theme::palette::cast::TryComponentsAs::Error">Error</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-TryComponentsAs%3C%5BC%5D%3E-for-Box%3C%5BT%5D%3E" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#225">Source</a><a href="#impl-TryComponentsAs%3C%5BC%5D%3E-for-Box%3C%5BT%5D%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, C, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.TryComponentsAs.html" title="trait cosmic::cosmic_theme::palette::cast::TryComponentsAs">TryComponentsAs</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>> for <a class="struct" href="../../../cctk/sctk/reexports/client/backend/smallvec/alloc/boxed/struct.Box.html" title="struct cosmic::cctk::sctk::reexports::client::backend::smallvec::alloc::boxed::Box">Box</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[T]</a>><div class="where">where
|
||
C: <a class="trait" href="trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-3" class="associatedtype trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#225">Source</a><a href="#associatedtype.Error-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.SliceCastError.html" title="struct cosmic::cosmic_theme::palette::cast::SliceCastError">SliceCastError</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryComponentsAs%3C%5BC%5D%3E-for-Vec%3CT%3E" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#225">Source</a><a href="#impl-TryComponentsAs%3C%5BC%5D%3E-for-Vec%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, C, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.TryComponentsAs.html" title="trait cosmic::cosmic_theme::palette::cast::TryComponentsAs">TryComponentsAs</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[C]</a>> for <a class="struct" href="../../../cctk/sctk/reexports/client/backend/smallvec/alloc/vec/struct.Vec.html" title="struct cosmic::cctk::sctk::reexports::client::backend::smallvec::alloc::vec::Vec">Vec</a><T><div class="where">where
|
||
C: <a class="trait" href="trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-4" class="associatedtype trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/cast/as_components_traits.rs.html#225">Source</a><a href="#associatedtype.Error-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.SliceCastError.html" title="struct cosmic::cosmic_theme::palette::cast::SliceCastError">SliceCastError</a></h4></section></div></details></div><script src="../../../../trait.impl/palette/cast/as_components_traits/trait.TryComponentsAs.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main></body></html> |