| 123456789101112 |
- <!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 that must be implemented by external metadata agents which allows the scanners to query for data."><meta name="keywords" content="rust, rustlang, rust-lang, ExternalQuery"><title>ExternalQuery in dim_extern_api - 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-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../static.files/ayu-65289d5d067c7c66.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-3367e395607fafc1.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 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">☰</button><a class="logo-container" href="../dim_extern_api/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../dim_extern_api/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">ExternalQuery</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.cast">cast</a></li><li><a href="#tymethod.search">search</a></li><li><a href="#tymethod.search_by_id">search_by_id</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In dim_extern_api</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>Trait <a href="index.html">dim_extern_api</a>::<wbr><a class="trait" href="#">ExternalQuery</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="../src/dim_extern_api/lib.rs.html#135-144">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><div class="item-decl"><pre class="rust"><code>pub trait ExternalQuery: <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
- fn <a href="#tymethod.search" class="fn">search</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> title: &'life1 <a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.str.html">str</a>,<br> year: <a class="enum" href="https://doc.rust-lang.org/1.68.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.i32.html">i32</a>><br> ) -> <a class="struct" href="https://doc.rust-lang.org/1.68.2/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="type.Result.html" title="type dim_extern_api::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.ExternalMedia.html" title="struct dim_extern_api::ExternalMedia">ExternalMedia</a>>>> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><br> <span class="where">where<br> Self: 'async_trait,<br> 'life0: 'async_trait,<br> 'life1: 'async_trait</span>;
- <span class="item-spacer"></span> fn <a href="#tymethod.search_by_id" class="fn">search_by_id</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> external_id: &'life1 <a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.str.html">str</a><br> ) -> <a class="struct" href="https://doc.rust-lang.org/1.68.2/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="type.Result.html" title="type dim_extern_api::Result">Result</a><<a class="struct" href="struct.ExternalMedia.html" title="struct dim_extern_api::ExternalMedia">ExternalMedia</a>>> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><br> <span class="where">where<br> Self: 'async_trait,<br> 'life0: 'async_trait,<br> 'life1: 'async_trait</span>;
- <span class="item-spacer"></span> fn <a href="#tymethod.cast" class="fn">cast</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> external_id: &'life1 <a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.str.html">str</a><br> ) -> <a class="struct" href="https://doc.rust-lang.org/1.68.2/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="type.Result.html" title="type dim_extern_api::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.ExternalActor.html" title="struct dim_extern_api::ExternalActor">ExternalActor</a>>>> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><br> <span class="where">where<br> Self: 'async_trait,<br> 'life0: 'async_trait,<br> 'life1: 'async_trait</span>;
- }</code></pre></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait that must be implemented by external metadata agents which allows the scanners to query
- for data.</p>
- </div></details><h2 id="required-methods" class="small-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.search" class="method has-srclink"><a class="srclink rightside" href="../src/dim_extern_api/lib.rs.html#138">source</a><h4 class="code-header">fn <a href="#tymethod.search" class="fn">search</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> title: &'life1 <a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.str.html">str</a>,<br> year: <a class="enum" href="https://doc.rust-lang.org/1.68.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.i32.html">i32</a>><br>) -> <a class="struct" href="https://doc.rust-lang.org/1.68.2/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="type.Result.html" title="type dim_extern_api::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.ExternalMedia.html" title="struct dim_extern_api::ExternalMedia">ExternalMedia</a>>>> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><span class="where fmt-newline">where<br> Self: 'async_trait,<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,</span></h4></section></summary><div class="docblock"><p>Search by title and year. This must return a Vec of <code>ExternalMedia</code> sorted by the search
- score.</p>
- </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.search_by_id" class="method has-srclink"><a class="srclink rightside" href="../src/dim_extern_api/lib.rs.html#141">source</a><h4 class="code-header">fn <a href="#tymethod.search_by_id" class="fn">search_by_id</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> external_id: &'life1 <a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.str.html">str</a><br>) -> <a class="struct" href="https://doc.rust-lang.org/1.68.2/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="type.Result.html" title="type dim_extern_api::Result">Result</a><<a class="struct" href="struct.ExternalMedia.html" title="struct dim_extern_api::ExternalMedia">ExternalMedia</a>>> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><span class="where fmt-newline">where<br> Self: 'async_trait,<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,</span></h4></section></summary><div class="docblock"><p>Search by external id. This must return a singular <code>ExternalMedia</code> which has the id passed
- in.</p>
- </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.cast" class="method has-srclink"><a class="srclink rightside" href="../src/dim_extern_api/lib.rs.html#143">source</a><h4 class="code-header">fn <a href="#tymethod.cast" class="fn">cast</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> external_id: &'life1 <a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.str.html">str</a><br>) -> <a class="struct" href="https://doc.rust-lang.org/1.68.2/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="type.Result.html" title="type dim_extern_api::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.ExternalActor.html" title="struct dim_extern_api::ExternalActor">ExternalActor</a>>>> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><span class="where fmt-newline">where<br> Self: 'async_trait,<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,</span></h4></section></summary><div class="docblock"><p>Get all actors for a media by external id. Actors must be ordered in order of importance.</p>
- </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ExternalQuery-for-MockProvider" class="impl has-srclink"><a class="srclink rightside" href="../src/dim_extern_api/mock.rs.html#10-25">source</a><a href="#impl-ExternalQuery-for-MockProvider" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ExternalQuery.html" title="trait dim_extern_api::ExternalQuery">ExternalQuery</a> for <a class="struct" href="mock/struct.MockProvider.html" title="struct dim_extern_api::mock::MockProvider">MockProvider</a></h3></section><section id="impl-ExternalQuery-for-MetadataProviderOf%3CK%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/dim_extern_api/tmdb/metadata_provider.rs.html#492-510">source</a><a href="#impl-ExternalQuery-for-MetadataProviderOf%3CK%3E" class="anchor">§</a><h3 class="code-header">impl<K> <a class="trait" href="trait.ExternalQuery.html" title="trait dim_extern_api::ExternalQuery">ExternalQuery</a> for <a class="struct" href="tmdb/struct.MetadataProviderOf.html" title="struct dim_extern_api::tmdb::MetadataProviderOf">MetadataProviderOf</a><K><span class="where fmt-newline">where<br> K: AssocMediaTypeConst + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</span></h3></section></div><script src="../implementors/dim_extern_api/trait.ExternalQuery.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="dim_extern_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.2 (9eb3afe9e 2023-03-27)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html>
|
