docs(sched): 📝 improve documentation
This commit is contained in:
parent
51a83371c6
commit
3a64661b0f
GPG Key ID:
EF34786CFEFFAE35
97
.github/img/unimplemented.svg
vendored
Normal file
97
.github/img/unimplemented.svg
vendored
Normal file
@ -0,0 +1,97 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 26.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 274 24" style="enable-background:new 0 0 274 24;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{enable-background:new ;}
|
||||
.st1{fill:#FFB74D;}
|
||||
</style>
|
||||
<g class="st0">
|
||||
<path class="st1" d="M46.8,15.9h-0.1c-0.5,1-1,1.9-1.7,2.5c-0.6,0.6-1.5,0.9-2.5,0.9c-0.6,0-1.2-0.1-1.6-0.3s-0.8-0.5-1.1-0.8
|
||||
c-0.3-0.3-0.5-0.7-0.6-1.2c-0.1-0.5-0.2-0.9-0.2-1.4c0-0.4,0-0.7,0.1-1.1c0-0.4,0.1-0.9,0.2-1.5l1.2-6.9H44l-1.2,7.3
|
||||
c0,0.2-0.1,0.5-0.1,0.7c0,0.2-0.1,0.5-0.1,0.9c0,0.2,0,0.3,0.1,0.5c0,0.2,0.1,0.3,0.3,0.5c0.1,0.1,0.3,0.3,0.5,0.4
|
||||
c0.2,0.1,0.4,0.1,0.7,0.1c0.4,0,0.8-0.1,1.1-0.3c0.3-0.2,0.6-0.5,0.9-0.9c0.2-0.2,0.4-0.6,0.7-1c0.3-0.4,0.4-0.9,0.5-1.5l1.1-6.7
|
||||
h3.6L49.9,19h-3.6L46.8,15.9z"/>
|
||||
<path class="st1" d="M53.3,19l2.1-12.9h3.6l-0.5,3.1h0.1c0.5-1,1-1.9,1.7-2.5c0.6-0.6,1.5-0.9,2.5-0.9c0.6,0,1.2,0.1,1.6,0.3
|
||||
c0.4,0.2,0.8,0.5,1.1,0.8c0.3,0.3,0.5,0.7,0.6,1.2c0.1,0.4,0.2,0.9,0.2,1.4c0,0.4,0,0.7-0.1,1.1c0,0.4-0.1,0.9-0.2,1.5L65.1,19
|
||||
h-3.7l1.2-7.3c0-0.2,0.1-0.5,0.1-0.7c0-0.2,0.1-0.5,0.1-0.8c0-0.2,0-0.3-0.1-0.5c0-0.2-0.1-0.3-0.3-0.5C62.4,9,62.2,8.8,62,8.7
|
||||
c-0.2-0.1-0.4-0.1-0.7-0.1c-0.4,0-0.8,0.1-1.1,0.3c-0.3,0.2-0.6,0.5-0.9,0.9c-0.2,0.2-0.4,0.6-0.7,1c-0.3,0.4-0.4,0.9-0.5,1.5
|
||||
L57,19H53.3z"/>
|
||||
<path class="st1" d="M75.2,19.3c-1,0-1.8-0.3-2.3-0.8c-0.5-0.5-0.8-1.3-0.8-2.2c0-0.3,0-0.6,0-0.8c0-0.3,0.1-0.7,0.2-1.2l1-5.4
|
||||
h-3.9l0.5-2.8h7.6l-1.9,10.2l0.4,0.1l3.5-3.6l2,1.8L80,16.4c-0.9,0.9-1.6,1.7-2.4,2.1C76.8,19.1,76,19.3,75.2,19.3z M76.2,4.4
|
||||
c-0.8,0-1.3-0.1-1.6-0.4c-0.3-0.3-0.5-0.7-0.5-1.1c0-0.1,0-0.2,0-0.3c0-0.1,0-0.4,0.1-0.7c0.1-0.5,0.3-0.9,0.7-1.2
|
||||
c0.4-0.3,0.9-0.4,1.7-0.4c0.8,0,1.3,0.1,1.6,0.4c0.3,0.3,0.5,0.7,0.5,1.1c0,0.1,0,0.2,0,0.3c0,0.1,0,0.4-0.1,0.7
|
||||
c-0.1,0.5-0.3,0.9-0.7,1.2C77.5,4.3,76.9,4.4,76.2,4.4z"/>
|
||||
<path class="st1" d="M82.4,19l2.1-12.9h2.9l-0.4,2.2h0.2c0.3-0.8,0.7-1.4,1.1-1.8c0.5-0.5,1-0.7,1.7-0.7c0.7,0,1.2,0.2,1.5,0.6
|
||||
c0.4,0.4,0.5,1.1,0.4,1.9h0.1c0.1-0.4,0.3-0.7,0.5-1c0.2-0.3,0.4-0.6,0.7-0.8c0.2-0.2,0.5-0.4,0.8-0.5c0.3-0.1,0.7-0.2,1.1-0.2
|
||||
c1.5,0,2.2,0.8,2.2,2.4c0,0.3,0,0.6,0,0.9c0,0.3-0.1,0.7-0.1,1L95.9,19h-3l1.4-8.5c0-0.1,0.1-0.3,0.1-0.5c0-0.2,0-0.4,0-0.5
|
||||
c0-0.3-0.1-0.5-0.2-0.7c-0.1-0.2-0.3-0.3-0.5-0.3c-0.2,0-0.4,0.1-0.6,0.2c-0.2,0.1-0.4,0.3-0.6,0.6c-0.2,0.2-0.3,0.5-0.4,0.8
|
||||
c-0.1,0.3-0.2,0.7-0.3,1.1L90.6,19h-2.9l1.4-8.5c0-0.1,0.1-0.3,0.1-0.5c0-0.2,0-0.4,0-0.5c0-0.6-0.2-0.9-0.7-0.9
|
||||
c-0.2,0-0.4,0-0.6,0.1c-0.2,0.1-0.4,0.3-0.6,0.7c-0.2,0.3-0.3,0.6-0.4,0.9c-0.1,0.3-0.2,0.5-0.2,0.8L85.4,19H82.4z"/>
|
||||
<path class="st1" d="M100.4,6.1h3.7l-0.5,3.1h0.1c0.2-0.5,0.5-1,0.8-1.4c0.3-0.4,0.6-0.8,0.9-1.1c0.3-0.3,0.7-0.5,1.1-0.7
|
||||
c0.4-0.2,0.9-0.3,1.5-0.3c0.7,0,1.3,0.1,1.7,0.4c0.5,0.2,0.9,0.6,1.2,1c0.3,0.4,0.5,1,0.7,1.6c0.1,0.6,0.2,1.3,0.2,2
|
||||
c0,1.3-0.1,2.4-0.4,3.5c-0.3,1-0.7,1.9-1.2,2.7c-0.5,0.7-1.1,1.3-1.9,1.7c-0.7,0.4-1.5,0.6-2.4,0.6c-1,0-1.8-0.2-2.3-0.7
|
||||
c-0.5-0.5-0.9-1.1-1.1-2h-0.2L101,24h-3.6L100.4,6.1z M104.7,16.4c0.9,0,1.6-0.3,2.1-0.8c0.5-0.5,0.8-1.3,1-2.2l0.2-1.5
|
||||
c0-0.1,0.1-0.3,0.1-0.5c0-0.2,0-0.4,0-0.6c0-0.6-0.1-1.1-0.4-1.5c-0.2-0.4-0.7-0.6-1.3-0.6c-0.5,0-0.9,0.1-1.2,0.3
|
||||
c-0.3,0.2-0.7,0.5-1,0.9c-0.2,0.2-0.4,0.6-0.7,1c-0.2,0.4-0.4,0.9-0.5,1.4l-0.3,2.1c-0.1,0.7,0,1.2,0.3,1.6S103.9,16.4,104.7,16.4z
|
||||
"/>
|
||||
<path class="st1" d="M119.5,19.3c-1,0-1.8-0.3-2.3-0.8c-0.5-0.5-0.8-1.3-0.8-2.2c0-0.3,0-0.6,0-0.8c0-0.3,0.1-0.7,0.2-1.2l2-11
|
||||
h-3.8l0.5-2.8h7.5l-2.9,15.8l0.4,0.1l3.5-3.6l2,1.8l-1.5,1.7c-0.9,0.9-1.6,1.7-2.4,2.1C121.1,19.1,120.3,19.3,119.5,19.3z"/>
|
||||
<path class="st1" d="M134.7,19.3c-1.9,0-3.3-0.5-4.2-1.5c-0.9-1-1.4-2.3-1.4-4c0-1.2,0.2-2.3,0.5-3.3s0.9-1.8,1.5-2.5
|
||||
c0.7-0.7,1.5-1.2,2.4-1.6c0.9-0.4,2-0.6,3.1-0.6c0.7,0,1.3,0.1,1.8,0.2c0.6,0.1,1.1,0.4,1.5,0.7c0.4,0.3,0.8,0.7,1,1.1
|
||||
c0.3,0.4,0.4,1,0.4,1.6c0,0.5-0.1,1-0.3,1.6c-0.2,0.5-0.6,1-1.3,1.4c-0.6,0.4-1.5,0.8-2.6,1.1c-1.1,0.3-2.6,0.5-4.5,0.5
|
||||
c0,0.1,0,0.2,0,0.2c0,0.1,0,0.1,0,0.2c0,0.7,0.2,1.2,0.6,1.6c0.4,0.4,1,0.5,1.9,0.5c0.4,0,0.7,0,1-0.1c0.3-0.1,0.6-0.2,0.9-0.4
|
||||
c0.3-0.2,0.5-0.4,0.8-0.7c0.3-0.3,0.6-0.6,0.9-1.1l2.3,1.5c-0.3,0.5-0.7,0.9-1.1,1.4c-0.4,0.4-0.8,0.8-1.3,1.1
|
||||
c-0.5,0.3-1.1,0.6-1.7,0.8C136.3,19.2,135.6,19.3,134.7,19.3z M136.3,8.4c-0.8,0-1.5,0.2-2,0.7c-0.6,0.5-1,1.3-1.2,2.4l-0.1,0.3
|
||||
c1.1-0.1,2.1-0.2,2.7-0.3c0.7-0.2,1.2-0.3,1.5-0.5c0.3-0.2,0.5-0.4,0.6-0.7s0.1-0.5,0.1-0.7C137.9,8.8,137.4,8.4,136.3,8.4z"/>
|
||||
<path class="st1" d="M142.4,19l2.1-12.9h2.9l-0.4,2.2h0.2c0.3-0.8,0.7-1.4,1.1-1.8c0.5-0.5,1-0.7,1.7-0.7c0.7,0,1.2,0.2,1.5,0.6
|
||||
c0.4,0.4,0.5,1.1,0.4,1.9h0.1c0.1-0.4,0.3-0.7,0.5-1c0.2-0.3,0.4-0.6,0.7-0.8s0.5-0.4,0.8-0.5c0.3-0.1,0.7-0.2,1.1-0.2
|
||||
c1.5,0,2.2,0.8,2.2,2.4c0,0.3,0,0.6,0,0.9c0,0.3-0.1,0.7-0.1,1l-1.5,8.9h-3l1.4-8.5c0-0.1,0.1-0.3,0.1-0.5c0-0.2,0-0.4,0-0.5
|
||||
c0-0.3-0.1-0.5-0.2-0.7c-0.1-0.2-0.3-0.3-0.5-0.3c-0.2,0-0.4,0.1-0.6,0.2c-0.2,0.1-0.4,0.3-0.6,0.6c-0.2,0.2-0.3,0.5-0.4,0.8
|
||||
c-0.1,0.3-0.2,0.7-0.3,1.1l-1.3,7.8h-2.9l1.4-8.5c0-0.1,0.1-0.3,0.1-0.5c0-0.2,0-0.4,0-0.5c0-0.6-0.2-0.9-0.7-0.9
|
||||
c-0.2,0-0.4,0-0.6,0.1c-0.2,0.1-0.4,0.3-0.6,0.7c-0.2,0.3-0.3,0.6-0.4,0.9c-0.1,0.3-0.2,0.5-0.2,0.8l-1.3,8.1H142.4z"/>
|
||||
<path class="st1" d="M164.7,19.3c-1.9,0-3.3-0.5-4.2-1.5c-0.9-1-1.4-2.3-1.4-4c0-1.2,0.2-2.3,0.5-3.3c0.4-1,0.9-1.8,1.5-2.5
|
||||
c0.7-0.7,1.5-1.2,2.4-1.6c0.9-0.4,2-0.6,3.1-0.6c0.7,0,1.3,0.1,1.8,0.2c0.6,0.1,1.1,0.4,1.5,0.7c0.4,0.3,0.8,0.7,1,1.1
|
||||
c0.3,0.4,0.4,1,0.4,1.6c0,0.5-0.1,1-0.3,1.6c-0.2,0.5-0.6,1-1.3,1.4c-0.6,0.4-1.5,0.8-2.6,1.1c-1.1,0.3-2.6,0.5-4.5,0.5
|
||||
c0,0.1,0,0.2,0,0.2c0,0.1,0,0.1,0,0.2c0,0.7,0.2,1.2,0.6,1.6c0.4,0.4,1,0.5,1.9,0.5c0.4,0,0.7,0,1-0.1c0.3-0.1,0.6-0.2,0.9-0.4
|
||||
c0.3-0.2,0.5-0.4,0.8-0.7c0.3-0.3,0.6-0.6,0.9-1.1l2.3,1.5c-0.3,0.5-0.7,0.9-1.1,1.4c-0.4,0.4-0.8,0.8-1.3,1.1
|
||||
c-0.5,0.3-1.1,0.6-1.7,0.8C166.3,19.2,165.5,19.3,164.7,19.3z M166.3,8.4c-0.8,0-1.5,0.2-2,0.7c-0.6,0.5-1,1.3-1.2,2.4l-0.1,0.3
|
||||
c1.1-0.1,2.1-0.2,2.7-0.3c0.7-0.2,1.2-0.3,1.5-0.5c0.3-0.2,0.5-0.4,0.6-0.7s0.1-0.5,0.1-0.7C167.9,8.8,167.4,8.4,166.3,8.4z"/>
|
||||
<path class="st1" d="M173.3,19l2.2-12.9h3.6l-0.5,3.1h0.1c0.5-1,1-1.9,1.7-2.5c0.6-0.6,1.5-0.9,2.5-0.9c0.6,0,1.2,0.1,1.6,0.3
|
||||
c0.4,0.2,0.8,0.5,1.1,0.8c0.3,0.3,0.5,0.7,0.6,1.2c0.1,0.4,0.2,0.9,0.2,1.4c0,0.4,0,0.7-0.1,1.1c0,0.4-0.1,0.9-0.2,1.5l-1.1,6.9
|
||||
h-3.6l1.2-7.3c0-0.2,0.1-0.5,0.1-0.7c0-0.2,0.1-0.5,0.1-0.8c0-0.2,0-0.3-0.1-0.5c0-0.2-0.1-0.3-0.3-0.5s-0.3-0.3-0.5-0.4
|
||||
c-0.2-0.1-0.4-0.1-0.7-0.1c-0.4,0-0.8,0.1-1.1,0.3c-0.3,0.2-0.6,0.5-0.9,0.9c-0.2,0.2-0.4,0.6-0.7,1c-0.3,0.4-0.4,0.9-0.5,1.5
|
||||
L177,19H173.3z"/>
|
||||
<path class="st1" d="M194.7,19.3c-1.1,0-1.9-0.3-2.4-0.9c-0.5-0.6-0.8-1.4-0.8-2.3c0-0.2,0-0.5,0-0.7c0-0.2,0.1-0.6,0.1-0.9
|
||||
l0.9-5.5h-3.3l0.5-2.8h2.1c0.5,0,0.9-0.1,1.2-0.3c0.3-0.2,0.5-0.6,0.5-1.2l0.5-3.1h3.4l-0.7,4.6h5L201.3,9h-5l-1.2,7.2l0.5,0.2
|
||||
l3.9-3.1l1.8,2.1l-1.5,1.3c-0.5,0.5-1,0.8-1.4,1.2c-0.4,0.3-0.8,0.6-1.2,0.9c-0.4,0.2-0.8,0.4-1.2,0.5
|
||||
C195.5,19.2,195.1,19.3,194.7,19.3z"/>
|
||||
<path class="st1" d="M209.7,19.3c-1.9,0-3.3-0.5-4.2-1.5c-0.9-1-1.4-2.3-1.4-4c0-1.2,0.2-2.3,0.5-3.3s0.9-1.8,1.5-2.5
|
||||
c0.7-0.7,1.5-1.2,2.4-1.6c0.9-0.4,2-0.6,3.1-0.6c0.7,0,1.3,0.1,1.8,0.2c0.6,0.1,1.1,0.4,1.5,0.7c0.4,0.3,0.8,0.7,1,1.1
|
||||
c0.3,0.4,0.4,1,0.4,1.6c0,0.5-0.1,1-0.3,1.6c-0.2,0.5-0.6,1-1.3,1.4c-0.6,0.4-1.5,0.8-2.6,1.1c-1.1,0.3-2.6,0.5-4.5,0.5
|
||||
c0,0.1,0,0.2,0,0.2c0,0.1,0,0.1,0,0.2c0,0.7,0.2,1.2,0.6,1.6c0.4,0.4,1,0.5,1.9,0.5c0.4,0,0.7,0,1-0.1c0.3-0.1,0.6-0.2,0.9-0.4
|
||||
c0.3-0.2,0.5-0.4,0.8-0.7c0.3-0.3,0.6-0.6,0.9-1.1l2.3,1.5c-0.3,0.5-0.7,0.9-1.1,1.4s-0.8,0.8-1.3,1.1c-0.5,0.3-1.1,0.6-1.7,0.8
|
||||
C211.3,19.2,210.5,19.3,209.7,19.3z M211.3,8.4c-0.8,0-1.5,0.2-2,0.7c-0.6,0.5-1,1.3-1.2,2.4l-0.1,0.3c1.1-0.1,2.1-0.2,2.7-0.3
|
||||
c0.7-0.2,1.2-0.3,1.5-0.5c0.3-0.2,0.5-0.4,0.6-0.7c0.1-0.2,0.1-0.5,0.1-0.7C212.9,8.8,212.4,8.4,211.3,8.4z"/>
|
||||
<path class="st1" d="M226.9,15.9h-0.1c-0.2,0.5-0.5,1-0.8,1.4c-0.3,0.4-0.6,0.8-0.9,1.1c-0.3,0.3-0.7,0.5-1.1,0.7
|
||||
c-0.4,0.2-0.9,0.3-1.5,0.3c-0.7,0-1.3-0.1-1.7-0.3c-0.5-0.2-0.9-0.6-1.2-1c-0.3-0.4-0.5-1-0.7-1.6c-0.1-0.6-0.2-1.3-0.2-2
|
||||
c0-1.3,0.1-2.4,0.4-3.5c0.3-1,0.7-1.9,1.2-2.7c0.5-0.7,1.1-1.3,1.9-1.7c0.7-0.4,1.5-0.6,2.4-0.6c1,0,1.8,0.2,2.3,0.7s0.9,1.1,1.1,2
|
||||
h0.2l1.3-8h3.6L230,19h-3.6L226.9,15.9z M224.1,16.4c0.5,0,0.9-0.1,1.2-0.3c0.4-0.2,0.7-0.5,1-0.9c0.2-0.2,0.4-0.6,0.7-1
|
||||
c0.3-0.4,0.4-0.9,0.5-1.4l0.3-2.1c0.1-0.7,0-1.2-0.3-1.6s-0.9-0.5-1.7-0.5c-0.9,0-1.6,0.3-2.1,0.8c-0.5,0.5-0.8,1.3-1,2.2l-0.3,1.5
|
||||
c0,0.2-0.1,0.3-0.1,0.5c0,0.2,0,0.4,0,0.6c0,0.6,0.1,1.1,0.4,1.5C223,16.2,223.4,16.4,224.1,16.4z"/>
|
||||
<path class="st1" d="M239.1,19.3c-0.8,0-1.3-0.2-1.7-0.5c-0.3-0.3-0.5-0.7-0.5-1.1c0-0.1,0-0.2,0-0.4c0-0.2,0.1-0.4,0.1-0.8
|
||||
c0.1-0.5,0.3-1,0.8-1.3c0.4-0.4,1-0.5,1.9-0.5c0.8,0,1.3,0.2,1.7,0.5s0.5,0.7,0.5,1.1c0,0.1,0,0.2,0,0.4c0,0.2-0.1,0.4-0.1,0.8
|
||||
c-0.1,0.5-0.3,1-0.8,1.3C240.6,19.1,239.9,19.3,239.1,19.3z M239.4,12.9l-0.3-6.3l0.8-5.1h4l-0.9,5.1l-2.4,6.3H239.4z"/>
|
||||
<path class="st1" d="M252,13c0-1.4,0.2-2.7,0.6-4c0.4-1.3,0.9-2.5,1.5-3.6c0.6-1.1,1.4-2.1,2.3-3.1c0.9-0.9,1.8-1.7,2.7-2.3h3.6
|
||||
c-0.9,0.6-1.7,1.3-2.5,2.1c-0.8,0.7-1.5,1.5-2.1,2.4c-0.6,0.8-1.1,1.7-1.6,2.6c-0.4,0.9-0.7,1.8-0.9,2.7l-0.4,2.4
|
||||
c0,0.3-0.1,0.6-0.1,0.8s0,0.5,0,0.8c0,0.8,0.1,1.6,0.3,2.5c0.2,0.8,0.5,1.6,0.9,2.4c0.4,0.8,0.8,1.5,1.2,2.1
|
||||
c0.5,0.7,0.9,1.3,1.5,1.7h-3.3c-0.5-0.5-1-1.1-1.4-1.7c-0.5-0.7-0.8-1.4-1.2-2.2c-0.3-0.8-0.6-1.7-0.8-2.6C252,15,252,14,252,13z"
|
||||
/>
|
||||
<path class="st1" d="M274,9.4c0,1.4-0.2,2.7-0.6,4c-0.4,1.3-0.9,2.5-1.5,3.6c-0.6,1.1-1.4,2.1-2.2,3.1c-0.9,0.9-1.8,1.7-2.7,2.3
|
||||
h-3.6c0.9-0.6,1.7-1.3,2.5-2.1c0.8-0.7,1.5-1.5,2.1-2.4c0.6-0.8,1.1-1.7,1.6-2.6c0.4-0.9,0.7-1.8,0.9-2.8l0.4-2.4
|
||||
c0-0.3,0.1-0.6,0.1-0.8c0-0.2,0-0.5,0-0.7c0-0.8-0.1-1.6-0.3-2.5c-0.2-0.8-0.5-1.6-0.9-2.4c-0.4-0.8-0.8-1.5-1.2-2.1
|
||||
c-0.5-0.7-0.9-1.3-1.5-1.8h3.3c0.5,0.5,1,1.1,1.4,1.8c0.4,0.7,0.8,1.4,1.2,2.2c0.3,0.8,0.6,1.7,0.8,2.6C273.9,7.5,274,8.4,274,9.4z
|
||||
"/>
|
||||
</g>
|
||||
<path class="st1" d="M16,0L0,24h32L16,0z M18,22h-4v-4h4V22z M14,16V8h4v8H14z"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 9.7 KiB |
@ -25,31 +25,48 @@ cargo add lool --registry=lugit --features sched {sub-feature}
|
||||
|
||||
# Sub-Features
|
||||
|
||||
## Runtimes
|
||||
|
||||
### <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a> sched.tokio
|
||||
At least one of the following features must be enabled to use this library.
|
||||
|
||||
Enables the `tokio` runtime support, replacing the default behaviour, which implies a `std::thread`
|
||||
pool to run the tasks.
|
||||
- <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a>
|
||||
**sched.tokio**: Enables the `tokio` runtime support.
|
||||
|
||||
> [!WARNING]
|
||||
>
|
||||
> Not yet implemented
|
||||
- <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a>
|
||||
**sched.threads**: Enables the `std::thread` runtime support.
|
||||
|
||||
### <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a> sched.rule-recurrent
|
||||
- <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a>
|
||||
**sched.thread-pool**: Enables the `std::thread` runtime support with a thread
|
||||
pool <img alt="unimplemented" src="../../.github/img/unimplemented.svg" height="12">
|
||||
|
||||
Enables the "**recurrent-rule**" style for scheduling tasks.
|
||||
## Scheduling Rules
|
||||
|
||||
### <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a> sched.rule-cron
|
||||
The default way to schedule tasks is to use a `DateTime` object. However, that means that the task
|
||||
will only run once. To schedule tasks to run at specific intervals, you can use the following
|
||||
features:
|
||||
|
||||
- <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a>
|
||||
**sched.rule-recurrent**: Enables the "**recurrent-rule**" style for scheduling tasks.
|
||||
|
||||
- <a href="#"><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></a>
|
||||
**sched.rule-cron**: Enables the "cron-like" style for scheduling tasks
|
||||
|
||||
> [!WARNING]
|
||||
>
|
||||
> Not yet implemented
|
||||
|
||||
## Planned Features
|
||||
|
||||
- `sched.rule-cron`: Enables the "cron-like" style for scheduling tasks
|
||||
- `sched.rule-pyschedule`: Enables the [python schedule](https://pypi.org/project/schedule/)-like
|
||||
- **sched.rule-pyschedule**: Enables the [python schedule](https://pypi.org/project/schedule/)-like
|
||||
style for scheduling tasks
|
||||
- **sched.thread-pool**: Enables the `std::thread` runtime support with a thread pool (like
|
||||
[scheduled-thread-pool](https://crates.io/crates/scheduled-thread-pool) crate but using `lool`'s
|
||||
thread pool implementation)
|
||||
|
||||
|
||||
# Usage
|
||||
|
||||
Check the [examples](../../examples) directory for usage examples:
|
||||
|
||||
- [tokio](../../examples/sched_tokio.rs): using the `tokio` runtime
|
||||
- [threads](../../examples/sched.rs): using the `std::thread` runtime
|
||||
|
||||
# Inspiration
|
||||
|
||||
@ -65,15 +82,3 @@ This library is inspired by several other libraries, including:
|
||||
- [python's schedule](https://pypi.org/project/schedule/): a simple python scheduler with
|
||||
a human-friendly API
|
||||
|
||||
|
||||
Other useful libraries that might come in handy for this project during development are:
|
||||
|
||||
- https://crates.io/crates/tokio-cron-scheduler
|
||||
- https://crates.io/crates/clokwerk
|
||||
- https://crates.io/crates/cron_tab
|
||||
- https://crates.io/crates/multithreading
|
||||
- https://crates.io/crates/multithreading
|
||||
- https://crates.io/crates/threadpool
|
||||
- https://crates.io/crates/blocking
|
||||
- https://crates.io/crates/scheduled-thread-pool
|
||||
- https://crates.io/crates/clokwerk
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user