<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js light">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Actor - CookBook of dyer</title>
<!-- Custom HTML head -->
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../highlight.css">
<link rel="stylesheet" href="../tomorrow-night.css">
<link rel="stylesheet" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
</head>
<body>
<!-- Provide site root to javascript -->
<script type="text/javascript">
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script type="text/javascript">
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
</script>
<!-- Hide / unhide sidebar before it is displayed -->
<script type="text/javascript">
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded "><a href="../intro.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="../dyer-cli/index.html"><strong aria-hidden="true">2.</strong> Dyer-cli</a></li><li class="chapter-item expanded "><a href="../actor/index.html" class="active"><strong aria-hidden="true">3.</strong> Actor</a></li><li class="chapter-item expanded "><a href="../middleware/index.html"><strong aria-hidden="true">4.</strong> Middleware</a></li><li class="chapter-item expanded "><a href="../database/index.html"><strong aria-hidden="true">5.</strong> Pipeline & Database Intergration</a></li><li class="chapter-item expanded "><a href="../affix/index.html"><strong aria-hidden="true">6.</strong> Affix</a></li><li class="chapter-item expanded "><a href="../attr/index.html"><strong aria-hidden="true">7.</strong> Attribute</a></li><li class="chapter-item expanded "><a href="../feedback/index.html"><strong aria-hidden="true">8.</strong> Problem & Feedback</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky bordered">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">CookBook of dyer</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script type="text/javascript">
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="actor"><a class="header" href="#actor">Actor</a></h1>
<p>Actor is trait that processing some methods to set up necessary conditions before the whole programs starts/ends. it basically categorizes:</p>
<ul>
<li><strong>Preparations Beforehand</strong> method <code>new</code>, <code>open_actor</code> and <code>close_actor</code> are provided to serve that purpose. First of all, you can define a struct according to your requirement, eg:</li>
</ul>
<pre><pre class="playground"><code class="language-rust no_run">
<span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>#[dyer::actor]
struct MyActor {
start_uris: Vec<String>
...
}
<span class="boring">}
</span></code></pre></pre>
<p>the struct <code>MyActor</code> should contain appropirate fields which initialized by the method <code>new</code>. </p>
<pre><pre class="playground"><code class="language-rust no_run">
<span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>#[dyer::async_trait]
impl Actor<_, _> for MyActor {
async fn new() -> Self {
Self {
start_uris: vec!["https://example.domain/path/to/site1".to_string(),
"https://example.domain/path/to/site2".to_string() ]
//other fields
...
}
}
// other method of Actor
...
}
<span class="boring">}
</span></code></pre></pre>
<p>before the whole program starts, the method <code>open_actor</code> gets called. preparation should be done here! but wait, what should we do here? let's extend the example above a little bit.</p>
<blockquote>
<p>all start uris are stored by lines in a file <code>uris.txt</code></p>
</blockquote>
<pre><pre class="playground"><code class="language-rust no_run">
<span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>#[dyer::actor]
pub struct MyActor {
start_uris: Vec<String>
}
#[dyer::async_trait]
impl Actor<_, _> for MyActor {
async fn new() -> Self {
use std::io::Read;
let mut file = std::fs::File::open("path/to/uris.txt").unwrap();
let buf = std::io::BufReader::new(file);
let uris = buf.lines().map(|line| {
line.unwrap()
}).collect::<Vec<String>>();
Self {
start_uris: uris
}
}
async fn open_actor(&mut self, _app: &mut App<_>) {
self.start_uris.for_each(|uri| {
Task::get(uri)
.parser(..)
.body(Body::empty(), "myactor_identifier".into())
.unwrap()
});
}
// other method of Actor
...
}
<span class="boring">}
</span></code></pre></pre>
<p>Analogously you can do some staff with <code>close_actor</code> when program ends.</p>
<ul>
<li><strong>Assignments Entry</strong> The program cannot starts without <code>Task</code>, <code>entry_task</code> serve as a way to add tasks to the lists. It expects a vector of <code>Task</code> when the function ends,</li>
</ul>
<pre><pre class="playground"><code class="language-rust no_run">
<span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>#[dyer::async_trait]
impl Actor<_, _> for MyActor {
async fn entry_task(&mut self) -> Result<Vec<Task>, Box<dyn Error>> {
self.start_uris.map(|uri| {
Task::get(uri)
.parser(..)
.body(Body::empty(), "myactor_identifier".into())
.unwrap()
}).collect::<_>()
}
// other method of Actor
...
}
<span class="boring">}
</span></code></pre></pre>
<p>As for <code>entry_affix</code>, it is commonly not necessary unless modification is required for that <code>Task</code>,
But what is that? before we answer that let's take a look at the structure of <a href="https://docs.rs/dyer/latest/dyer/struct.Task.html">Task</a>, </p>
<pre><pre class="playground"><code class="language-rust no_run">
<span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct Task {
/// main infomation that represents a `Task`
pub(crate) inner: InnerTask,
/// Formdata, files or other request parameters stored here
pub(crate) body: Body,
...
}
pub struct InnerTask {
pub uri: Uri,
/// request's vesoin
pub method: Method,
/// additional headers if necessary
pub headers: HeaderMap<HeaderValue>,
...
}
<span class="boring">}
</span></code></pre></pre>
<p>it is obvious to see that a <code>Task</code> almost contains infomation to make a request.</p>
<p>But when does <code>entry_affix</code> play its role? Here are some scenarios that you may use it.</p>
<ol>
<li>Headers Modification (eg. Cookies, User-Agents, Tokens, and etc.)</li>
<li>javascript simulation</li>
<li>FFI and others</li>
</ol>
<p>Here we focus on the first one(most used) and an example is given at section <a href="../actor/readme.html">Actor</a>.</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../dyer-cli/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="../middleware/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../dyer-cli/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="../middleware/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<!-- Livereload script (if served using the cli tool) -->
<script type="text/javascript">
var socket = new WebSocket("ws://localhost:3000/__livereload");
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};
window.onbeforeunload = function() {
socket.close();
}
</script>
<script type="text/javascript">
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
<!-- Custom JS scripts -->
</body>
</html>