Keyboard Shortcuts
- "+shortcuts+"
fn:) to \
- restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
- enum, trait, type, macro, \
- and const.","Search functions by type signature (e.g., vec -> usize or \
- * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
- str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
- your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(function(x){return""+x+"
"}).join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="Search Tricks
"+infos;container.appendChild(book_info);container.appendChild(div_shortcuts);container.appendChild(div_infos);var rustdoc_version=document.createElement("span");rustdoc_version.className="bottom";var rustdoc_version_code=document.createElement("code");rustdoc_version_code.innerText="rustdoc "+getVar("rustdoc-version");rustdoc_version.appendChild(rustdoc_version_code);container.appendChild(rustdoc_version);popup.appendChild(container);insertAfter(popup,document.querySelector("main"));buildHelperPopup=function(){}};onHashChange(null);window.addEventListener("hashchange",onHashChange);searchState.setup()}());(function(){var reset_button_timeout=null;window.copy_path=function(but){var parent=but.parentElement;var path=[];onEach(parent.childNodes,function(child){if(child.tagName==='A'){path.push(child.textContent)}});var el=document.createElement('textarea');el.value=path.join('::');el.setAttribute('readonly','');el.style.position='absolute';el.style.left='-9999px';document.body.appendChild(el);el.select();document.execCommand('copy');document.body.removeChild(el);but.children[0].style.display='none';var tmp;if(but.childNodes.length<2){tmp=document.createTextNode('✓');but.appendChild(tmp)}else{onEachLazy(but.childNodes,function(e){if(e.nodeType===Node.TEXT_NODE){tmp=e;return true}});tmp.textContent='✓'}if(reset_button_timeout!==null){window.clearTimeout(reset_button_timeout)}function reset_button(){tmp.textContent='';reset_button_timeout=null;but.children[0].style.display=""}reset_button_timeout=window.setTimeout(reset_button,1000)}}()) \ No newline at end of file diff --git a/docs/doc/noscript.css b/docs/doc/noscript.css deleted file mode 100644 index 8ad8864..0000000 --- a/docs/doc/noscript.css +++ /dev/null @@ -1 +0,0 @@ - #main-content .attributes{margin-left:0 !important;}#copy-path{display:none;}.sub{display:none;}#theme-picker{display:none;} \ No newline at end of file diff --git a/docs/doc/rustdoc.css b/docs/doc/rustdoc.css deleted file mode 100644 index 07de4cb..0000000 --- a/docs/doc/rustdoc.css +++ /dev/null @@ -1 +0,0 @@ - @font-face {font-family:'Fira Sans';font-style:normal;font-weight:400;src:local('Fira Sans'),url("FiraSans-Regular.woff2") format("woff2"),url("FiraSans-Regular.woff") format('woff');font-display:swap;}@font-face {font-family:'Fira Sans';font-style:normal;font-weight:500;src:local('Fira Sans Medium'),url("FiraSans-Medium.woff2") format("woff2"),url("FiraSans-Medium.woff") format('woff');font-display:swap;}@font-face {font-family:'Source Serif 4';font-style:normal;font-weight:400;src:local('Source Serif 4'),url("SourceSerif4-Regular.ttf.woff2") format("woff2"),url("SourceSerif4-Regular.ttf.woff") format("woff");font-display:swap;}@font-face {font-family:'Source Serif 4';font-style:italic;font-weight:400;src:local('Source Serif 4 Italic'),url("SourceSerif4-It.ttf.woff2") format("woff2"),url("SourceSerif4-It.ttf.woff") format("woff");font-display:swap;}@font-face {font-family:'Source Serif 4';font-style:normal;font-weight:700;src:local('Source Serif 4 Bold'),url("SourceSerif4-Bold.ttf.woff2") format("woff2"),url("SourceSerif4-Bold.ttf.woff") format("woff");font-display:swap;}@font-face {font-family:'Source Code Pro';font-style:normal;font-weight:400;src:url("SourceCodePro-Regular.ttf.woff2") format("woff2"),url("SourceCodePro-Regular.ttf.woff") format("woff");font-display:swap;}@font-face {font-family:'Source Code Pro';font-style:italic;font-weight:400;src:url("SourceCodePro-It.ttf.woff2") format("woff2"),url("SourceCodePro-It.ttf.woff") format("woff");font-display:swap;}@font-face {font-family:'Source Code Pro';font-style:normal;font-weight:600;src:url("SourceCodePro-Semibold.ttf.woff2") format("woff2"),url("SourceCodePro-Semibold.ttf.woff") format("woff");font-display:swap;}@font-face {font-family:'NanumBarunGothic';src:url("NanumBarunGothic.ttf.woff2") format("woff2"),url("NanumBarunGothic.ttf.woff") format("woff");font-display:swap;unicode-range:U+AC00-D7AF,U+1100-11FF,U+3130-318F,U+A960-A97F,U+D7B0-D7FF;}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;}html{content:"";}@media (prefers-color-scheme:light){html{content:"light";}}@media (prefers-color-scheme:dark){html{content:"dark";}}body{font:1rem/1.5 "Source Serif 4",NanumBarunGothic,serif;margin:0;position:relative;overflow-wrap:break-word;overflow-wrap:anywhere;-webkit-font-feature-settings:"kern","liga";-moz-font-feature-settings:"kern","liga";font-feature-settings:"kern","liga";}h1{font-size:1.5rem;}h2{font-size:1.375rem;}h3{font-size:1.25rem;}h1,h2,h3,h4,h5,h6{font-weight:500;}h1,h2,h3,h4{margin:20px 0 15px 0;padding-bottom:6px;}.docblock h3,.docblock h4,h5,h6{margin:15px 0 5px 0;}h1.fqn{margin:0;padding:0;}.main-heading{display:flex;flex-wrap:wrap;justify-content:space-between;padding-bottom:6px;margin-bottom:15px;}.main-heading a:hover{text-decoration:underline;}#toggle-all-docs{text-decoration:none;}h2,.top-doc h3,.top-doc h4{border-bottom:1px solid;}h3.code-header{font-size:1.125rem;}h4.code-header{font-size:1rem;}.code-header{font-weight:600;border-bottom-style:none;margin:0;padding:0;margin-top:0.6em;margin-bottom:0.4em;}.impl,.impl-items .method,.methods .method,.impl-items .type,.methods .type,.impl-items .associatedconstant,.methods .associatedconstant,.impl-items .associatedtype,.methods .associatedtype{flex-basis:100%;font-weight:600;position:relative;}div.impl-items>div{padding-left:0;}h1,h2,h3,h4,h5,h6,.sidebar,.mobile-topbar,a.source,.search-input,.search-results .result-name,.content table td:first-child>a,.item-left>a,.out-of-band,span.since,#source-sidebar,#sidebar-toggle,details.rustdoc-toggle>summary::before,div.impl-items>div:not(.docblock):not(.item-info),.content ul.crate a.crate,a.srclink,#main-content>ul.docblock>li>a{font-family:"Fira Sans",Arial,NanumBarunGothic,sans-serif;}ol,ul{padding-left:24px;}ul ul,ol ul,ul ol,ol ol{margin-bottom:.625em;}p{margin:0 0 .75em 0;}summary{outline:none;}td,th{padding:0;}table{border-collapse:collapse;}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0;}button{padding:1px 6px;}.rustdoc{display:flex;flex-direction:row;flex-wrap:nowrap;}main{position:relative;flex-grow:1;padding:10px 15px 40px 45px;min-width:0;}.source main{padding:15px;}.width-limiter{max-width:960px;margin-right:auto;}.source .width-limiter{max-width:unset;}details:not(.rustdoc-toggle) summary{margin-bottom:.6em;}code,pre,a.test-arrow,.code-header{font-family:"Source Code Pro",monospace;}.docblock code,.docblock-short code{border-radius:3px;padding:0 0.125em;}.docblock pre code,.docblock-short pre code{padding:0;}pre{padding:14px;}.docblock.item-decl{margin-left:0;}.item-decl pre{overflow-x:auto;}.source .content pre{padding:20px;}img{max-width:100%;}li{position:relative;}.source .content{max-width:none;overflow:visible;margin-left:0px;}nav.sub{position:relative;font-size:1rem;text-transform:uppercase;}.sub-container{display:flex;flex-direction:row;flex-wrap:nowrap;}.sub-logo-container{display:none;margin-right:20px;}.source .sub-logo-container{display:block;}.source .sub-logo-container>img{height:60px;width:60px;object-fit:contain;}.sidebar{font-size:0.875rem;width:250px;min-width:200px;overflow-y:scroll;position:sticky;height:100vh;top:0;left:0;}.sidebar-elems,.sidebar>.location{padding-left:24px;}.sidebar .location{overflow-wrap:anywhere;}.rustdoc.source .sidebar{width:50px;min-width:0px;max-width:300px;flex-grow:0;flex-shrink:0;flex-basis:auto;border-right:1px solid;overflow-x:hidden;overflow-y:hidden;}.source .sidebar>*:not(:first-child){transition:opacity 0.5s;opacity:0;visibility:hidden;}.source .sidebar.expanded{overflow-y:auto;}.source .sidebar.expanded>*{opacity:1;visibility:visible;}#all-types{margin-top:1em;}*{scrollbar-width:initial;}.sidebar{scrollbar-width:thin;}::-webkit-scrollbar{width:12px;}.sidebar::-webkit-scrollbar{width:8px;}::-webkit-scrollbar-track{-webkit-box-shadow:inset 0;}.hidden{display:none !important;}.sidebar .logo-container{display:flex;margin-top:10px;margin-bottom:10px;justify-content:center;}.version{overflow-wrap:break-word;}.logo-container>img{height:100px;width:100px;}.location:empty{border:none;}.location a:first-of-type{font-weight:500;}.block{padding:0;}.block ul,.block li{padding:0;margin:0;list-style:none;}.block a,h2.location a{display:block;padding:0.25rem;margin-left:-0.25rem;text-overflow:ellipsis;overflow:hidden;}.sidebar h2{border-bottom:none;font-weight:500;padding:0;margin:0;margin-top:0.7rem;margin-bottom:0.7rem;}.sidebar h3{font-size:1.125rem;font-weight:500;padding:0;margin:0;}.sidebar-elems .block{margin-bottom:2em;}.sidebar-elems .block li a{white-space:nowrap;}.mobile-topbar{display:none;}.source .content pre.rust{white-space:pre;overflow:auto;padding-left:0;}.rustdoc .example-wrap{display:inline-flex;margin-bottom:10px;}.example-wrap{position:relative;width:100%;}.example-wrap>pre.line-number{overflow:initial;border:1px solid;padding:13px 8px;text-align:right;border-top-left-radius:5px;border-bottom-left-radius:5px;}.example-wrap>pre.rust a:hover{text-decoration:underline;}.rustdoc:not(.source) .example-wrap>pre:not(.line-number){width:100%;overflow-x:auto;}.rustdoc:not(.source) .example-wrap>pre.line-numbers{width:auto;overflow-x:visible;}.rustdoc .example-wrap>pre{margin:0;}#search{position:relative;}.search-loading{text-align:center;}#results>table{width:100%;table-layout:fixed;}.content>.example-wrap pre.line-numbers{position:relative;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;}.line-numbers span{cursor:pointer;}.docblock-short{overflow-wrap:break-word;overflow-wrap:anywhere;}.docblock-short p{display:inline;}.docblock-short p{overflow:hidden;text-overflow:ellipsis;margin:0;}.docblock>:not(pre)>code,.docblock-short>:not(pre)>code{white-space:pre-wrap;}.top-doc .docblock h2{font-size:1.375rem;}.top-doc .docblock h3{font-size:1.25;}.top-doc .docblock h4,.top-doc .docblock h5{font-size:1.125rem;}.top-doc .docblock h6{font-size:1rem;}.docblock h5{font-size:1rem;}.docblock h6{font-size:0.875rem;}.docblock{margin-left:24px;position:relative;}.docblock>:not(.information){max-width:100%;overflow-x:auto;}.content .out-of-band{flex-grow:0;font-size:1.125rem;font-weight:normal;float:right;}.method>.code-header,.trait-impl>.code-header{max-width:calc(100% - 41px);display:block;}.invisible{width:100%;display:inline-block;}.content .in-band{flex-grow:1;margin:0px;padding:0px;overflow-wrap:break-word;overflow-wrap:anywhere;}.in-band>code,.in-band>.code-header{display:inline-block;}#main-content{position:relative;}#main-content>.since{top:inherit;font-family:"Fira Sans",Arial,sans-serif;}.content table:not(.table-display){border-spacing:0 5px;}.content td{vertical-align:top;}.content td:first-child{padding-right:20px;}.content td p:first-child{margin-top:0;}.content td h1,.content td h2{margin-left:0;font-size:1.125rem;}.content tr:first-child td{border-top:0;}.docblock table{margin:.5em 0;width:calc(100% - 2px);overflow-x:auto;display:block;}.docblock table td{padding:.5em;border:1px dashed;}.docblock table th{padding:.5em;text-align:left;border:1px solid;}.fields+table{margin-bottom:1em;}.content .item-list{list-style-type:none;padding:0;}.content .multi-column{-moz-column-count:5;-moz-column-gap:2.5em;-webkit-column-count:5;-webkit-column-gap:2.5em;column-count:5;column-gap:2.5em;}.content .multi-column li{width:100%;display:inline-block;}.content>.methods>.method{font-size:1rem;position:relative;}.content .method .where,.content .fn .where,.content .where.fmt-newline{display:block;font-size:0.875rem;}.content .methods>div:not(.notable-traits):not(.method){margin-left:40px;margin-bottom:15px;}.content .docblock>.impl-items{margin-left:20px;margin-top:-34px;}.content .docblock>.impl-items .table-display{margin:0;}.content .docblock>.impl-items table td{padding:0;}.content .docblock>.impl-items .table-display,.impl-items table td{border:none;}.content .item-info code{font-size:0.875rem;}.content .item-info{position:relative;margin-left:24px;}.sub-variant>div>.item-info{margin-top:initial;}.content .impl-items .docblock,.content .impl-items .item-info{margin-bottom:.6em;}.content .impl-items>.item-info{margin-left:40px;}.methods>.item-info,.content .impl-items>.item-info{margin-top:-8px;}.impl-items{flex-basis:100%;}#main-content>.item-info{margin-top:0;margin-left:0;}nav.sub{flex-grow:1;margin-bottom:25px;}.source nav.sub{margin-left:32px;}nav.main{padding:20px 0;text-align:center;}nav.main .current{border-top:1px solid;border-bottom:1px solid;}nav.main .separator{border:1px solid;display:inline-block;height:23px;margin:0 20px;}nav.sum{text-align:right;}nav.sub form{display:inline;}a{text-decoration:none;background:transparent;}.small-section-header{display:flex;justify-content:space-between;position:relative;}.small-section-header:hover>.anchor{display:initial;}.in-band:hover>.anchor,.impl:hover>.anchor,.method.trait-impl:hover>.anchor,.type.trait-impl:hover>.anchor,.associatedconstant.trait-impl:hover>.anchor,.associatedtype.trait-impl:hover>.anchor{display:inline-block;position:absolute;}.anchor{display:none;position:absolute;left:-0.5em;background:none !important;}.anchor.field{left:-5px;}.small-section-header>.anchor{left:-15px;padding-right:8px;}h2.small-section-header>.anchor{padding-right:6px;}.anchor::before{content:'§';}.docblock a:not(.srclink):not(.test-arrow):hover,.docblock-short a:not(.srclink):not(.test-arrow):hover,.item-info a{text-decoration:underline;}.block a.current.crate{font-weight:500;}table,.item-table{overflow-wrap:break-word;}.item-table{display:table;}.item-row{display:table-row;}.item-left,.item-right{display:table-cell;}.item-left{padding-right:1.25rem;}.search-container{position:relative;display:flex;height:34px;}.search-container>*{height:100%;}.search-results-title{display:inline;}#search-settings{font-size:1.5rem;font-weight:500;margin-bottom:20px;}#crate-search{min-width:115px;margin-top:5px;margin-left:0.25em;padding-left:0.3125em;padding-right:23px;border:0;border-radius:4px;outline:none;cursor:pointer;-moz-appearance:none;-webkit-appearance:none;text-indent:0.01px;text-overflow:"";background-repeat:no-repeat;background-color:transparent;background-size:20px;background-position:calc(100% - 1px) 56%;background-image:url("down-arrow.svg");}.search-container{margin-top:4px;}.search-input{-webkit-appearance:none;-moz-box-sizing:border-box !important;box-sizing:border-box !important;outline:none;border:1px solid;border-radius:2px;padding:8px;font-size:1rem;transition:border-color 300ms ease;width:100%;}.search-results{display:none;padding-bottom:2em;}.search-results.active{display:block;clear:both;}.search-results .desc>span{white-space:nowrap;text-overflow:ellipsis;overflow:hidden;display:block;}.search-results>a{display:block;width:100%;margin-left:2px;margin-right:2px;border-bottom:1px solid #aaa3;}.search-results>a>div{display:flex;flex-flow:row wrap;}.search-results .result-name,.search-results div.desc,.search-results .result-description{width:50%;}.search-results .result-name{padding-right:1em;}.search-results .result-name>span{display:inline-block;margin:0;font-weight:normal;}body.blur>:not(#help){filter:blur(8px);-webkit-filter:blur(8px);opacity:.7;}#help{width:100%;height:100vh;position:fixed;top:0;left:0;display:flex;justify-content:center;align-items:center;}#help>div{flex:0 0 auto;box-shadow:0 0 6px rgba(0,0,0,.2);width:550px;height:auto;border:1px solid;}#help dt{float:left;clear:left;display:block;margin-right:0.5rem;}#help span.top,#help span.bottom{text-align:center;display:block;font-size:1.125rem;}#help span.top{text-align:center;display:block;margin:10px 0;border-bottom:1px solid;padding-bottom:4px;margin-bottom:6px;}#help span.bottom{clear:both;border-top:1px solid;}#help dd{margin:5px 35px;}#help .infos{padding-left:0;}#help h1,#help h2{margin-top:0;}#help>div div{width:50%;float:left;padding:0 20px 20px 17px;;}.item-info .stab{display:inline-block;}.stab{padding:3px;margin-bottom:5px;font-size:0.875rem;font-weight:normal;}.stab p{display:inline;}.stab .emoji{font-size:1.25rem;}.emoji{text-shadow:1px 0 0 black,-1px 0 0 black,0 1px 0 black,0 -1px 0 black;}.module-item .stab,.import-item .stab{border-radius:3px;display:inline-block;font-size:0.875rem;line-height:1.2;margin-bottom:0;margin-left:0.3125em;padding:2px;vertical-align:text-bottom;}.module-item.unstable,.import-item.unstable{opacity:0.65;}.since{font-weight:normal;font-size:initial;}.rightside{padding-left:12px;padding-right:2px;position:initial;}.impl-items .srclink,.impl .srclink,.methods .srclink{font-weight:normal;font-size:1rem;}.rightside{float:right;}.variants_table{width:100%;}.variants_table tbody tr td:first-child{width:1%;}td.summary-column{width:100%;}.summary{padding-right:0px;}pre.rust .question-mark{font-weight:bold;}a.test-arrow{display:inline-block;visibility:hidden;position:absolute;padding:5px 10px 5px 10px;border-radius:5px;font-size:1.375rem;top:5px;right:5px;z-index:1;}.example-wrap:hover .test-arrow{visibility:visible;}a.test-arrow:hover{text-decoration:none;}.code-attribute{font-weight:300;}.item-spacer{width:100%;height:12px;}.out-of-band>span.since{position:initial;font-size:1.25rem;}h3.variant{font-weight:600;font-size:1.125rem;margin-bottom:10px;border-bottom:none;}.sub-variant h4{font-size:1rem;font-weight:400;border-bottom:none;margin-top:0;margin-bottom:0;}.sub-variant{margin-left:24px;margin-bottom:40px;}.sub-variant>.sub-variant-field{margin-left:24px;}.toggle-label{display:inline-block;margin-left:4px;margin-top:3px;}:target>code,:target>.code-header{opacity:1;}:target{padding-right:3px;}.information{position:absolute;left:-25px;margin-top:7px;z-index:1;}.tooltip{position:relative;display:inline-block;cursor:pointer;}.tooltip::after{display:none;text-align:center;padding:5px 3px 3px 3px;border-radius:6px;margin-left:5px;font-size:1rem;}.tooltip.ignore::after{content:"This example is not tested";}.tooltip.compile_fail::after{content:"This example deliberately fails to compile";}.tooltip.should_panic::after{content:"This example panics";}.tooltip.edition::after{content:"This code runs with edition " attr(data-edition);}.tooltip::before{content:" ";position:absolute;top:50%;left:16px;margin-top:-5px;border-width:5px;border-style:solid;display:none;}.tooltip:hover::before,.tooltip:hover::after{display:inline;}.tooltip.compile_fail,.tooltip.should_panic,.tooltip.ignore{font-weight:bold;font-size:1.25rem;}.notable-traits-tooltip{display:inline-block;cursor:pointer;}.notable-traits:hover .notable-traits-tooltiptext,.notable-traits .notable-traits-tooltiptext.force-tooltip{display:inline-block;}.notable-traits .notable-traits-tooltiptext{display:none;padding:5px 3px 3px 3px;border-radius:6px;margin-left:5px;z-index:10;font-size:1rem;cursor:default;position:absolute;border:1px solid;}.notable-traits-tooltip::after{content:"\00a0\00a0\00a0";}.notable-traits .notable,.notable-traits .docblock{margin:0;}.notable-traits .notable{margin:0;margin-bottom:13px;font-size:1.1875rem;font-weight:600;display:block;}.notable-traits .docblock code.content{margin:0;padding:0;font-size:1.25rem;}pre.rust.rust-example-rendered{position:relative;}pre.rust{tab-size:4;-moz-tab-size:4;}.search-failed{text-align:center;margin-top:20px;display:none;}.search-failed.active{display:block;}.search-failed>ul{text-align:left;max-width:570px;margin-left:auto;margin-right:auto;}#titles{height:35px;}#titles>button{float:left;width:33.3%;text-align:center;font-size:1.125rem;cursor:pointer;border:0;border-top:2px solid;}#titles>button:not(:last-child){margin-right:1px;width:calc(33.3% - 1px);}#titles>button>div.count{display:inline-block;font-size:1rem;}.notable-traits{cursor:pointer;z-index:2;margin-left:5px;}#sidebar-toggle{position:sticky;top:0;left:0;cursor:pointer;font-weight:bold;font-size:1.25rem;border-bottom:1px solid;display:flex;height:40px;justify-content:center;align-items:center;z-index:10;}#source-sidebar{width:100%;z-index:1;overflow:auto;}#source-sidebar>.title{font-size:1.5rem;text-align:center;border-bottom:1px solid;margin-bottom:6px;}.theme-picker{position:absolute;left:-38px;top:4px;}.theme-picker button{outline:none;}#settings-menu,#help-button{margin-left:4px;outline:none;}#theme-picker,#copy-path{height:34px;}#theme-picker,#settings-menu,#help-button,#copy-path{padding:5px;width:33px;border:1px solid;border-radius:2px;cursor:pointer;}#help-button{font-family:"Fira Sans",Arial,sans-serif;text-align:center;font-size:20px;padding-top:2px;}#copy-path{background:initial;margin-left:10px;padding:0;padding-left:2px;border:0;}#theme-choices{display:none;position:absolute;left:0;top:28px;border:1px solid;border-radius:3px;z-index:1;cursor:pointer;}#theme-choices>button{border:none;width:100%;padding:4px 8px;text-align:center;background:rgba(0,0,0,0);overflow-wrap:normal;}#theme-choices>button:not(:first-child){border-top:1px solid;}kbd{display:inline-block;padding:3px 5px;font:15px monospace;line-height:10px;vertical-align:middle;border:solid 1px;border-radius:3px;cursor:default;}.hidden-by-impl-hider,.hidden-by-usual-hider{display:none !important;}#implementations-list>h3>span.in-band{width:100%;}.table-display{width:100%;border:0;border-collapse:collapse;border-spacing:0;font-size:1rem;}.table-display tr td:first-child{padding-right:0;}.table-display tr td:last-child{float:right;}.table-display .out-of-band{position:relative;font-size:1.125rem;display:block;}.table-display td:hover .anchor{display:block;top:2px;left:-5px;}#main-content>ul{padding-left:10px;}#main-content>ul>li{list-style:none;}.non-exhaustive{margin-bottom:1em;}div.children{padding-left:27px;display:none;}div.name{cursor:pointer;position:relative;margin-left:16px;}div.files>a{display:block;padding:0 3px;}div.files>a:hover,div.name:hover{background-color:#a14b4b;}div.name.expand+.children{display:block;}div.name::before{content:"\25B6";padding-left:4px;font-size:0.625rem;position:absolute;left:-16px;top:4px;}div.name.expand::before{transform:rotate(90deg);left:-15px;top:2px;}details.rustdoc-toggle>summary.hideme{cursor:pointer;}details.rustdoc-toggle>summary{list-style:none;}details.rustdoc-toggle>summary::-webkit-details-marker,details.rustdoc-toggle>summary::marker{display:none;}details.rustdoc-toggle>summary.hideme>span{margin-left:9px;}details.rustdoc-toggle>summary::before{content:"";cursor:pointer;width:16px;height:16px;background-repeat:no-repeat;background-position:top left;display:inline-block;vertical-align:middle;opacity:.5;}details.rustdoc-toggle>summary::after{content:"Expand";overflow:hidden;width:0;height:0;position:absolute;}details.rustdoc-toggle>summary.hideme::after{content:"";}details.rustdoc-toggle>summary:focus::before,details.rustdoc-toggle>summary:hover::before{opacity:1;}details.rustdoc-toggle.top-doc>summary,details.rustdoc-toggle.top-doc>summary::before,details.rustdoc-toggle.non-exhaustive>summary,details.rustdoc-toggle.non-exhaustive>summary::before{font-family:'Fira Sans';font-size:1rem;}details.non-exhaustive{margin-bottom:8px;}details.rustdoc-toggle>summary.hideme::before{position:relative;}details.rustdoc-toggle>summary:not(.hideme)::before{position:absolute;left:-24px;top:4px;}.impl-items>details.rustdoc-toggle>summary:not(.hideme)::before{position:absolute;left:-24px;}details.rustdoc-toggle[open] >summary.hideme{position:absolute;}details.rustdoc-toggle{position:relative;}details.rustdoc-toggle[open] >summary.hideme>span{display:none;}details.undocumented[open] >summary::before,details.rustdoc-toggle[open] >summary::before,details.rustdoc-toggle[open] >summary.hideme::before{background-image:url("toggle-minus.svg");}details.undocumented>summary::before,details.rustdoc-toggle>summary::before{background-image:url("toggle-plus.svg");}details.rustdoc-toggle[open] >summary::before,details.rustdoc-toggle[open] >summary.hideme::before{width:16px;height:16px;background-repeat:no-repeat;background-position:top left;display:inline-block;content:"";}details.rustdoc-toggle[open] >summary::after,details.rustdoc-toggle[open] >summary.hideme::after{content:"Collapse";}@media (min-width:701px){.docblock>.information:first-child>.tooltip{margin-top:16px;}.sidebar.expanded+main .width-limiter .sub-logo-container.rust-logo{display:none;}.rustdoc.source .sidebar{transition:width .5s;}.source .sidebar.expanded{width:300px;}}@media (max-width:700px){*[id]{scroll-margin-top:45px;}.rustdoc{padding-top:0px;display:block;}main{padding-left:15px;padding-top:0px;}.rustdoc,.main-heading{flex-direction:column;}.content .out-of-band{text-align:left;margin-left:initial;padding:initial;}.content .out-of-band .since::before{content:"Since ";}#copy-path{display:none;}.sidebar .sidebar-logo,.sidebar .location{display:none;}.sidebar-elems{margin-top:1em;}.sidebar{position:fixed;top:45px;left:-1000px;margin-left:0;background-color:rgba(0,0,0,0);margin:0;padding:0;z-index:11;height:calc(100vh - 45px);}.source main,.source .sidebar{top:0;padding:0;}.sidebar.shown,.sidebar.expanded,.sidebar:focus-within{left:0;}.rustdoc.source>.sidebar{position:fixed;margin:0;z-index:11;width:0;}.mobile-topbar .location a{padding:0;margin:0;}.mobile-topbar .location{border:none;padding:0;margin:auto 0.5em auto auto;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;font-size:24px;}.mobile-topbar .logo-container{max-height:45px;}.mobile-topbar .logo-container>img{max-width:35px;max-height:35px;margin-left:20px;margin-top:5px;margin-bottom:5px;}.mobile-topbar{display:flex;flex-direction:row;position:sticky;z-index:10;font-size:2rem;height:45px;width:100%;left:0;top:0;}.source .mobile-topbar{display:none;}.sidebar-menu-toggle{width:45px;font-size:32px;border:none;}.source nav:not(.sidebar).sub{margin-left:32px;}#theme-picker{display:none;width:0;}.content{margin-left:0px;}.source .content{margin-top:10px;}#search{margin-left:0;padding:0;}.anchor{display:none !important;}.notable-traits{position:absolute;left:-22px;top:24px;}#titles>button>div.count{float:left;width:100%;}#titles{height:50px;}#sidebar-filler{position:fixed;left:45px;width:calc(100% - 45px);top:0;height:45px;z-index:-1;border-bottom:1px solid;}#main-content>details.rustdoc-toggle>summary::before,#main-content>div>details.rustdoc-toggle>summary::before{left:-11px;}.sidebar.expanded #sidebar-toggle{font-size:1.5rem;}.sidebar:not(.expanded) #sidebar-toggle{position:fixed;left:1px;top:100px;width:30px;font-size:1.5rem;text-align:center;padding:0;z-index:10;border-top-right-radius:3px;border-bottom-right-radius:3px;cursor:pointer;font-weight:bold;border:1px solid;border-left:0;}#source-sidebar{z-index:11;}#main-content>.line-numbers{margin-top:0;}.notable-traits .notable-traits-tooltiptext{left:0;top:100%;}#help-button{display:none;}.item-table{display:block;}.item-row{display:flex;flex-flow:column wrap;}.item-left,.item-right{width:100%;}.search-results>a{border-bottom:1px solid #aaa9;padding:5px 0px;}.search-results .result-name,.search-results div.desc,.search-results .result-description{width:100%;}.search-results div.desc,.search-results .result-description,.item-right{padding-left:2em;}.source .sidebar.expanded{max-width:100vw;width:100vw;}details.rustdoc-toggle:not(.top-doc)>summary{margin-left:10px;}.impl-items>details.rustdoc-toggle>summary:not(.hideme)::before,#main-content>details.rustdoc-toggle:not(.top-doc)>summary::before,#main-content>div>details.rustdoc-toggle>summary::before{left:-11px;}}@media print{nav.sub,.content .out-of-band{display:none;}}@media (max-width:464px){#titles,#titles>button{height:73px;}#main-content>table:not(.table-display) td{word-break:break-word;width:50%;}#crate-search{border-radius:4px;border:0;}.docblock{margin-left:12px;}.docblock code{overflow-wrap:break-word;overflow-wrap:anywhere;}.sub-container{flex-direction:column;}.sub-logo-container{align-self:center;}.source .sub-logo-container>img{height:35px;width:35px;}.sidebar:not(.expanded) #sidebar-toggle{top:10px;}}.method-toggle summary,.implementors-toggle summary,.impl{margin-bottom:0.75em;}.method-toggle[open]{margin-bottom:2em;}.implementors-toggle[open]{margin-bottom:2em;}#trait-implementations-list .method-toggle,#synthetic-implementations-list .method-toggle,#blanket-implementations-list .method-toggle{margin-bottom:1em;}.scraped-example-title{font-family:'Fira Sans';}.scraped-example:not(.expanded) .code-wrapper pre.line-numbers{overflow:hidden;max-height:240px;}.scraped-example:not(.expanded) .code-wrapper .example-wrap pre.rust{overflow-y:hidden;max-height:240px;padding-bottom:0;}.scraped-example .code-wrapper .prev{position:absolute;top:0.25em;right:2.25em;z-index:100;cursor:pointer;}.scraped-example .code-wrapper .next{position:absolute;top:0.25em;right:1.25em;z-index:100;cursor:pointer;}.scraped-example .code-wrapper .expand{position:absolute;top:0.25em;right:0.25em;z-index:100;cursor:pointer;}.scraped-example .code-wrapper{position:relative;display:flex;flex-direction:row;flex-wrap:wrap;width:100%;}.scraped-example:not(.expanded) .code-wrapper:before{content:" ";width:100%;height:5px;position:absolute;z-index:100;top:0;background:linear-gradient(to bottom,rgba(255,255,255,1),rgba(255,255,255,0));}.scraped-example:not(.expanded) .code-wrapper:after{content:" ";width:100%;height:5px;position:absolute;z-index:100;bottom:0;background:linear-gradient(to top,rgba(255,255,255,1),rgba(255,255,255,0));}.scraped-example:not(.expanded) .code-wrapper{overflow:hidden;max-height:240px;}.scraped-example .code-wrapper .line-numbers{margin:0;padding:14px 0;}.scraped-example .code-wrapper .line-numbers span{padding:0 14px;}.scraped-example .code-wrapper .example-wrap{flex:1;overflow-x:auto;overflow-y:hidden;margin-bottom:0;}.scraped-example .code-wrapper .example-wrap pre.rust{overflow-x:inherit;width:inherit;overflow-y:hidden;}.scraped-example .example-wrap .rust span.highlight{background:#fcffd6;}.scraped-example .example-wrap .rust span.highlight.focus{background:#f6fdb0;}.more-examples-toggle{margin-top:10px;}.more-examples-toggle summary{color:#999;font-family:'Fira Sans';}.more-scraped-examples{margin-left:25px;display:flex;flex-direction:row;width:calc(100% - 25px);}.more-scraped-examples-inner{width:calc(100% - 20px);}.toggle-line{align-self:stretch;margin-right:10px;margin-top:5px;padding:0 4px;cursor:pointer;}.toggle-line:hover .toggle-line-inner{background:#aaa;}.toggle-line-inner{min-width:2px;background:#ddd;height:100%;}.more-scraped-examples .scraped-example{margin-bottom:20px;}.more-scraped-examples .scraped-example:last-child{margin-bottom:0;}.example-links a{margin-top:20px;font-family:'Fira Sans';}.example-links ul{margin-bottom:0;} \ No newline at end of file diff --git a/docs/doc/search-index.js b/docs/doc/search-index.js index 89fa0ab..121419e 100644 --- a/docs/doc/search-index.js +++ b/docs/doc/search-index.js @@ -1,4 +1,5 @@ var searchIndex = JSON.parse('{\ -"ubits":{"doc":"crates.io Downloads Build Docs Licence","t":[14,0,0,0,18,18,3,18,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,18,18,3,4,13,13,13,13,13,13,13,13,18,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11],"n":["bitfield","examples","flagless_example","full_example","BITS","BYTES","ExampleField","MAX","as_binary","as_integer","bitand","bitand_assign","bitor","bitor_assign","bitxor","bitxor_assign","borrow","borrow_mut","clear_index","clone","clone_into","combine","default","diff","eq","fmt","fmt","from","from","from_binary_str","from_binary_string","get_index","intersect","into","into_combined","into_diff","into_intersection","ne","new","ones","partial_cmp","set_index","to_owned","toggle_index","try_from","try_into","type_id","zeros","BITS","BYTES","ExampleField","ExampleFlags","Flag0","Flag1","Flag2","Flag3","Flag4","Flag5","Flag6","Flag7","MAX","as_binary","as_integer","bitand","bitand","bitand","bitand_assign","bitand_assign","bitor","bitor","bitor","bitor_assign","bitor_assign","bitxor","bitxor","bitxor","bitxor_assign","bitxor_assign","borrow","borrow","borrow_mut","borrow_mut","clear","clear_index","clone","clone","clone_into","clone_into","combine","default","diff","eq","eq","fmt","fmt","fmt","from","from","from","from","from","from_binary_str","from_binary_string","get","get_index","intersect","into","into","into_combined","into_diff","into_intersection","ne","new","ones","partial_cmp","partial_cmp","set","set_index","to_owned","to_owned","toggle","toggle_index","try_from","try_from","try_into","try_into","type_id","type_id","zeros"],"q":["ubits","","ubits::examples","","ubits::examples::flagless_example","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","ubits::examples::full_example","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""],"d":["Generates a bitfield struct and a corresponding flag enum.","Examples of generated output using different …","Example of generated output, using only a bit field …","Example of generated output, using both a bit field and a …","Number of bits in an instance ofExampleField.","Number of bytes used by an instance of ExampleField.","Optional docstring for my example bit field.","Maximum valid integer for ExampleField.","Returns the current field value as a binary formatted …","Returns the current field value as a u8","","","","","","","","","Sets the value of the bit at the supplied index to 0.","","","Returns a new ExampleFieldwith ones for flags that were …","","Returns a new ExampleFieldwith ones for flags that do not …","","","","Returns the argument unchanged.","","Create a new instance of ExampleField from a binary string.","Create a new instance of ExampleField from a binary string.","Returns the value of the bit at the supplied index as a …","Returns a new ExampleFieldwith ones for flags that were …","Calls U::from(self).","Returns a new ExampleFieldwith ones for flags that were …","Returns a new ExampleFieldwith ones for flags that do not …","Returns a new ExampleFieldwith ones for flags that were …","","Create a new instance of ExampleField from a u8 value.","Create a new instance of ExampleField from the maximum …","","Sets the value of the bit at the supplied index to 1.","","Flips the value of the bit at the supplied index.","","","","Create a new instance of ExampleField from 0.","Number of bits in an instance of ExampleField.","Number of bytes used by an instance of ExampleField.","Optional docstring for my example bit field.","Optional docstring for my flag enum.","Optional docstring for Flag0","Optional docstring for Flag1","Optional docstring for Flag2","Optional docstring for Flag3","Optional docstring for Flag4","Optional docstring for Flag5","Optional docstring for Flag6","Optional docstring for Flag7","Maximum valid integer for ExampleField.","Returns the current field value as a binary formatted …","Returns the current field value as a u8","","","","","","","","","","","","","","","","","","","","Sets the value of the bit at the supplied flag to 0.","Sets the value of the bit at the supplied index to 0.","","","","","Returns a new ExampleFieldwith ones for flags that were …","","Returns a new ExampleFieldwith ones for flags that do not …","","","","","","","Returns the argument unchanged.","","","Returns the argument unchanged.","Create a new instance of ExampleField from a binary string.","Create a new instance of ExampleField from a binary string.","Returns the value of the bit at the supplied flag as a …","Returns the value of the bit at the supplied index as a …","Returns a new ExampleFieldwith ones for flags that were …","Calls U::from(self).","Calls U::from(self).","Returns a new ExampleFieldwith ones for flags that were …","Returns a new ExampleFieldwith ones for flags that do not …","Returns a new ExampleFieldwith ones for flags that were …","","Create a new instance of ExampleField from a u8 value.","Create a new instance of ExampleField from the maximum …","","","Sets the value of the bit at the supplied flag to 1.","Sets the value of the bit at the supplied index to 1.","","","Flips the value of the bit at the supplied flag.","Flips the value of the bit at the supplied index.","","","","","","","Create a new instance of ExampleField from 0."],"i":[0,0,0,0,1,1,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,2,2,0,0,3,3,3,3,3,3,3,3,2,2,2,3,2,2,2,2,3,2,2,2,2,3,2,2,2,2,3,2,3,2,2,2,3,2,3,2,2,2,2,3,2,3,2,2,3,3,2,2,2,2,2,2,2,2,3,2,2,2,2,2,2,2,3,2,2,2,3,2,2,2,3,2,3,2,3,2,2],"f":[null,null,null,null,null,null,null,null,[[["",0]],["string",3]],[[["",0]],["u8",0]],[[]],[[["",0]]],[[]],[[["",0]]],[[]],[[["",0]]],[[["",0]],["",0]],[[["",0]],["",0]],[[["",0],["u8",0]]],[[["",0]],["examplefield",3]],[[["",0],["",0]]],[[["",0]]],[[]],[[["",0]]],[[["",0],["examplefield",3]],["bool",0]],[[["",0],["formatter",3]],["result",6]],[[["",0],["formatter",3]],["result",6]],[[]],[[["u8",0]],["examplefield",3]],[[["str",0]]],[[["string",3]]],[[["",0],["u8",0]],["bool",0]],[[["",0]]],[[]],[[]],[[]],[[]],[[["",0],["examplefield",3]],["bool",0]],[[["u8",0]]],[[]],[[["",0],["examplefield",3]],["option",4,[["ordering",4]]]],[[["",0],["u8",0]]],[[["",0]]],[[["",0],["u8",0]]],[[],["result",4]],[[],["result",4]],[[["",0]],["typeid",3]],[[]],null,null,null,null,null,null,null,null,null,null,null,null,null,[[["",0]],["string",3]],[[["",0]],["u8",0]],[[]],[[["exampleflags",4]]],[[]],[[["",0],["exampleflags",4]]],[[["",0]]],[[]],[[]],[[["exampleflags",4]]],[[["",0],["exampleflags",4]]],[[["",0]]],[[]],[[["exampleflags",4]]],[[]],[[["",0],["exampleflags",4]]],[[["",0]]],[[["",0]],["",0]],[[["",0]],["",0]],[[["",0]],["",0]],[[["",0]],["",0]],[[["",0],["exampleflags",4]],["",0]],[[["",0],["u8",0]]],[[["",0]],["exampleflags",4]],[[["",0]],["examplefield",3]],[[["",0],["",0]]],[[["",0],["",0]]],[[["",0]]],[[]],[[["",0]]],[[["",0],["exampleflags",4]],["bool",0]],[[["",0],["examplefield",3]],["bool",0]],[[["",0],["formatter",3]],["result",6]],[[["",0],["formatter",3]],["result",6]],[[["",0],["formatter",3]],["result",6]],[[["u8",0]],["exampleflags",4]],[[]],[[["u8",0]],["examplefield",3]],[[["exampleflags",4]],["examplefield",3]],[[]],[[["str",0]]],[[["string",3]]],[[["",0],["exampleflags",4]],["bool",0]],[[["",0],["u8",0]],["bool",0]],[[["",0]]],[[]],[[]],[[]],[[]],[[]],[[["",0],["examplefield",3]],["bool",0]],[[["u8",0]]],[[]],[[["",0],["exampleflags",4]],["option",4,[["ordering",4]]]],[[["",0],["examplefield",3]],["option",4,[["ordering",4]]]],[[["",0],["exampleflags",4]],["",0]],[[["",0],["u8",0]]],[[["",0]]],[[["",0]]],[[["",0],["exampleflags",4]],["",0]],[[["",0],["u8",0]]],[[],["result",4]],[[],["result",4]],[[],["result",4]],[[],["result",4]],[[["",0]],["typeid",3]],[[["",0]],["typeid",3]],[[]]],"p":[[3,"ExampleField"],[3,"ExampleField"],[4,"ExampleFlags"]]}\
+"ubits":{"doc":"crates.io Downloads Build Docs Licence","t":"OAAASSDSLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLSSDENNNNNNNNSLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL","n":["bitfield","examples","flagless_example","full_example","BITS","BYTES","ExampleField","MAX","as_binary","as_integer","bitand","bitand_assign","bitor","bitor_assign","bitxor","bitxor_assign","borrow","borrow_mut","clear_index","clone","clone_into","combine","default","diff","eq","fmt","fmt","from","from","from_binary_str","from_binary_string","get_index","intersect","into","into_combined","into_diff","into_intersection","new","ones","partial_cmp","set_index","to_owned","toggle_index","try_from","try_into","type_id","zeros","BITS","BYTES","ExampleField","ExampleFlags","Flag0","Flag1","Flag2","Flag3","Flag4","Flag5","Flag6","Flag7","MAX","as_binary","as_integer","bitand","bitand","bitand","bitand","bitand","bitand_assign","bitand_assign","bitor","bitor","bitor","bitor","bitor","bitor_assign","bitor_assign","bitxor","bitxor","bitxor","bitxor","bitxor","bitxor_assign","bitxor_assign","borrow","borrow","borrow_mut","borrow_mut","clear","clear_index","clone","clone","clone_into","clone_into","combine","default","diff","eq","eq","fmt","fmt","fmt","from","from","from","from","from","from_binary_str","from_binary_string","get","get_index","intersect","into","into","into_combined","into_diff","into_intersection","new","ones","partial_cmp","partial_cmp","set","set_index","to_owned","to_owned","toggle","toggle_index","try_from","try_from","try_into","try_into","type_id","type_id","zeros"],"q":[[0,"ubits"],[2,"ubits::examples"],[4,"ubits::examples::flagless_example"],[47,"ubits::examples::full_example"]],"d":["Generates a bitfield struct and a corresponding flag enum.","Examples of generated output using different …","Example of generated output, using only a bit field …","Example of generated output, using both a bit field and a …","Number of bits in an instance of ExampleField.","Number of bytes used by an instance of ExampleField.","Optional docstring for my example bit field.","Maximum valid integer for ExampleField.","Returns the current field value as a binary formatted …","Returns the current field value as a u8","","","","","","","","","Sets the value of the bit at the supplied index to 0.","","","Returns a new ExampleFieldwith ones for flags that were …","","Returns a new ExampleFieldwith ones for flags that do not …","","","","","Returns the argument unchanged.","Create a new instance of ExampleField from a binary string.","Create a new instance of ExampleField from a binary string.","Returns the value of the bit at the supplied index as a …","Returns a new ExampleFieldwith ones for flags that were …","Calls U::from(self).","Returns a new ExampleFieldwith ones for flags that were …","Returns a new ExampleFieldwith ones for flags that do not …","Returns a new ExampleFieldwith ones for flags that were …","Create a new instance of ExampleField from a u8 value.","Create a new instance of ExampleField from the maximum …","","Sets the value of the bit at the supplied index to 1.","","Flips the value of the bit at the supplied index.","","","","Create a new instance of ExampleField from 0.","Number of bits in an instance of ExampleField.","Number of bytes used by an instance of ExampleField.","Optional docstring for my example bit field.","Optional docstring for my flag enum.","Optional docstring for Flag0","Optional docstring for Flag1","Optional docstring for Flag2","Optional docstring for Flag3","Optional docstring for Flag4","Optional docstring for Flag5","Optional docstring for Flag6","Optional docstring for Flag7","Maximum valid integer for ExampleField.","Returns the current field value as a binary formatted …","Returns the current field value as a u8","","","","","","","","","","","","","","","","","","","","","","","","","","Sets the value of the bit at the supplied flag to 0.","Sets the value of the bit at the supplied index to 0.","","","","","Returns a new ExampleFieldwith ones for flags that were …","","Returns a new ExampleFieldwith ones for flags that do not …","","","","","","Returns the argument unchanged.","","Returns the argument unchanged.","","","Create a new instance of ExampleField from a binary string.","Create a new instance of ExampleField from a binary string.","Returns the value of the bit at the supplied flag as a …","Returns the value of the bit at the supplied index as a …","Returns a new ExampleFieldwith ones for flags that were …","Calls U::from(self).","Calls U::from(self).","Returns a new ExampleFieldwith ones for flags that were …","Returns a new ExampleFieldwith ones for flags that do not …","Returns a new ExampleFieldwith ones for flags that were …","Create a new instance of ExampleField from a u8 value.","Create a new instance of ExampleField from the maximum …","","","Sets the value of the bit at the supplied flag to 1.","Sets the value of the bit at the supplied index to 1.","","","Flips the value of the bit at the supplied flag.","Flips the value of the bit at the supplied index.","","","","","","","Create a new instance of ExampleField from 0."],"i":[0,0,0,0,1,1,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,12,12,0,0,13,13,13,13,13,13,13,13,12,12,12,13,12,12,12,12,12,12,13,12,12,12,12,12,12,13,12,12,12,12,12,12,13,12,13,12,12,12,13,12,13,12,12,12,12,13,12,13,12,12,13,13,12,12,12,12,12,12,12,12,13,12,12,12,12,12,12,13,12,12,12,13,12,12,12,13,12,13,12,13,12,12],"f":[0,0,0,0,0,0,0,0,[1,2],[1,3],[[1,1]],[[1,1]],[[1,1]],[[1,1]],[[1,1]],[[1,1]],[[]],[[]],[[1,3]],[1,1],[[]],[[1,1],1],[[],1],[[1,1],1],[[1,1],4],[[1,5],6],[[1,5],6],[3,1],[[]],[7,1],[2,1],[[1,3],4],[[1,1],1],[[]],[[1,1],1],[[1,1],1],[[1,1],1],[3,1],[[],1],[[1,1],[[9,[8]]]],[[1,3]],[[]],[[1,3]],[[],10],[[],10],[[],11],[[],1],0,0,0,0,0,0,0,0,0,0,0,0,0,[12,2],[12,3],[[13,13]],[[12,13]],[[12,13]],[[12,12]],[[12,13]],[[12,13]],[[12,12]],[[13,13]],[[12,13]],[[12,13]],[[12,13]],[[12,12]],[[12,12]],[[12,13]],[[13,13]],[[12,13]],[[12,12]],[[12,13]],[[12,13]],[[12,12]],[[12,13]],[[]],[[]],[[]],[[]],[[12,13],12],[[12,3]],[13,13],[12,12],[[]],[[]],[[12,12],12],[[],12],[[12,12],12],[[13,13],4],[[12,12],4],[[13,5],6],[[12,5],6],[[12,5],6],[[]],[3,13],[[]],[13,12],[3,12],[7,12],[2,12],[[12,13],4],[[12,3],4],[[12,12],12],[[]],[[]],[[12,12],12],[[12,12],12],[[12,12],12],[3,12],[[],12],[[13,13],[[9,[8]]]],[[12,12],[[9,[8]]]],[[12,13],12],[[12,3]],[[]],[[]],[[12,13],12],[[12,3]],[[],10],[[],10],[[],10],[[],10],[[],11],[[],11],[[],12]],"c":[],"p":[[3,"ExampleField"],[3,"String"],[15,"u8"],[15,"bool"],[3,"Formatter"],[6,"Result"],[15,"str"],[4,"Ordering"],[4,"Option"],[4,"Result"],[3,"TypeId"],[3,"ExampleField"],[4,"ExampleFlags"]]}\
}');
-if (window.initSearch) {window.initSearch(searchIndex)};
\ No newline at end of file
+if (typeof window !== 'undefined' && window.initSearch) {window.initSearch(searchIndex)};
+if (typeof exports !== 'undefined') {exports.searchIndex = searchIndex};
diff --git a/docs/doc/search.js b/docs/doc/search.js
deleted file mode 100644
index a8026db..0000000
--- a/docs/doc/search.js
+++ /dev/null
@@ -1,2 +0,0 @@
-(function(){var itemTypes=["mod","externcrate","import","struct","enum","fn","type","static","trait","impl","tymethod","method","structfield","variant","macro","primitive","associatedtype","constant","associatedconstant","union","foreigntype","keyword","existential","attr","derive","traitalias",];var TY_PRIMITIVE=itemTypes.indexOf("primitive");var TY_KEYWORD=itemTypes.indexOf("keyword");function printTab(nb){if(nb===0||nb===1||nb===2){searchState.currentTab=nb}var nb_copy=nb;onEachLazy(document.getElementById("titles").childNodes,function(elem){if(nb_copy===0){addClass(elem,"selected")}else{removeClass(elem,"selected")}nb_copy-=1});onEachLazy(document.getElementById("results").childNodes,function(elem){if(nb===0){addClass(elem,"active")}else{removeClass(elem,"active")}nb-=1})}function removeEmptyStringsFromArray(x){for(var i=0,len=x.length;i"+"Try on DuckDuckGo?
"+"Or try looking in one of these:
- The Rust Reference "+" for technical details about the language.
- Rust By "+"Example for expository code examples.
- The Rust Book for "+"introductions to language features and the language itself.
- Docs.rs for documentation of crates released on"+" crates.io.
-
Results for ${escape(query.query)} `+(query.type?" (type: "+escape(query.type)+")":"")+"
"+crates+``+makeTabHeader(0,"In Names",ret_others[1])+makeTabHeader(1,"In Parameters",ret_in_args[1])+makeTabHeader(2,"In Return Types",ret_returned[1])+"
";var resultsElem=document.createElement("div");resultsElem.id="results";resultsElem.appendChild(ret_others[0]);resultsElem.appendChild(ret_in_args[0]);resultsElem.appendChild(ret_returned[0]);search.innerHTML=output;let crateSearch=document.getElementById("crate-search");if(crateSearch){crateSearch.addEventListener("input",updateCrate)}search.appendChild(resultsElem);searchState.focusedByTab=[null,null,null];searchState.showResults(search);var elems=document.getElementById("titles").childNodes;elems[0].onclick=function(){printTab(0)};elems[1].onclick=function(){printTab(1)};elems[2].onclick=function(){printTab(2)};printTab(currentTab)}function execSearch(query,searchWords,filterCrates){query=query.raw.trim();var results={"in_args":[],"returned":[],"others":[],};if(query.length!==0){var tmp=execQuery(getQuery(query),searchWords,filterCrates);results.in_args.push(tmp.in_args);results.returned.push(tmp.returned);results.others.push(tmp.others)}return{"in_args":results.in_args[0],"returned":results.returned[0],"others":results.others[0],}}function search(e,forced){var params=searchState.getQueryStringParams();var query=getQuery(searchState.input.value.trim());if(e){e.preventDefault()}if(query.query.length===0){return}if(!forced&&query.id===currentResults){if(query.query.length>0){putBackSearch()}return}var filterCrates=getFilterCrates();if(filterCrates===null&¶ms["filter-crate"]!==undefined){filterCrates=params["filter-crate"]}searchState.title="Results for "+query.query+" - Rust";if(searchState.browserSupportsHistoryApi()){var newURL=buildUrl(query.raw,filterCrates);if(!history.state&&!params.search){history.pushState(null,"",newURL)}else{history.replaceState(null,"",newURL)}}showResults(execSearch(query,searchWords,filterCrates),params["go_to_first"],filterCrates)}function buildIndex(rawSearchIndex){searchIndex=[];var searchWords=[];var i,word;var currentIndex=0;var id=0;for(var crate in rawSearchIndex){if(!hasOwnPropertyRustdoc(rawSearchIndex,crate)){continue}var crateSize=0;var crateCorpus=rawSearchIndex[crate];searchWords.push(crate);var crateRow={crate:crate,ty:1,name:crate,path:"",desc:crateCorpus.doc,parent:undefined,type:null,id:id,normalizedName:crate.indexOf("_")===-1?crate:crate.replace(/_/g,""),};id+=1;searchIndex.push(crateRow);currentIndex+=1;var itemTypes=crateCorpus.t;var itemNames=crateCorpus.n;var itemPaths=crateCorpus.q;var itemDescs=crateCorpus.d;var itemParentIdxs=crateCorpus.i;var itemFunctionSearchTypes=crateCorpus.f;var paths=crateCorpus.p;var aliases=crateCorpus.a;var len=paths.length;for(i=0;i
-
Rustdoc settings
BackUse system theme
Theme
Preferred light theme
Preferred dark theme
Auto-hide item contents for large items.
Auto-hide item methods' documentation
Auto-hide trait implementation documentation
Directly go to item in search if there is only one result
Show line numbers on code examples
Disable keyboard shortcuts
Rustdoc settings
Back
1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 112 - 113 - 114 - 115 - 116 - 117 - 118 - 119 - 120 - 121 - 122 - 123 - 124 - 125 - 126 - 127 - 128 - 129 - 130 - 131 - 132 - 133 - 134 - 135 - 136 - 137 - 138 - 139 - 140 - 141 - 142 - 143 - 144 - 145 - 146 - 147 - 148 - 149 - 150 - 151 - 152 - 153 - 154 - 155 - 156 - 157 - 158 - 159 - 160 - 161 - 162 - 163 - 164 - 165 - 166 - 167 - 168 - 169 - 170 - 171 - 172 - 173 - 174 - 175 - 176 - 177 - 178 - 179 - 180 - 181 - 182 - 183 - 184 - 185 - 186 - 187 - 188 - 189 - 190 - 191 - 192 - 193 - 194 - 195 - 196 - 197 - 198 - 199 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 209 - 210 - 211 - 212 - 213 - 214 - 215 - 216 - 217 - 218 - 219 - 220 - 221 - 222 - 223 - 224 - 225 - 226 - 227 - 228 - 229 - 230 - 231 - 232 - 233 - 234 - 235 - 236 - 237 - 238 - 239 - 240 - 241 - 242 - 243 - 244 - 245 - 246 - 247 - 248 - 249 - 250 - 251 - 252 - 253 - 254 - 255 - 256 - 257 - 258 - 259 - 260 - 261 - 262 - 263 - 264 - 265 - 266 - 267 - 268 - 269 - 270 - 271 - 272 - 273 - 274 - 275 - 276 - 277 - 278 - 279 - 280 - 281 - 282 - 283 - 284 - 285 - 286 - 287 - 288 - 289 - 290 - 291 - 292 - 293 - 294 - 295 - 296 - 297 - 298 - 299 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 309 - 310 - 311 - 312 - 313 - 314 - 315 - 316 - 317 - 318 - 319 - 320 - 321 - 322 - 323 - 324 - 325 - 326 - 327 - 328 - 329 - 330 - 331 - 332 - 333 - 334 - 335 - 336 - 337 - 338 - 339 - 340 - 341 - 342 - 343 - 344 - 345 - 346 - 347 - 348 - 349 - 350 - 351 - 352 - 353 - 354 - 355 - 356 - 357 - 358 - 359 - 360 - 361 - 362 - 363 - 364 - 365 - 366 - 367 - 368 - 369 - 370 - 371 - 372 - 373 - 374 - 375 - 376 - 377 - 378 - 379 - 380 - 381 - 382 - 383 - 384 - 385 - 386 - 387 - 388 - 389 - 390 - 391 - 392 - 393 - 394 - 395 - 396 - 397 - 398 - 399 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 418 - 419 - 420 - 421 - 422 - 423 - 424 - 425 - 426 - 427 - 428 - 429 - 430 - 431 - 432 - 433 - 434 - 435 - 436 - 437 - 438 - 439 - 440 - 441 - 442 - 443 - 444 - 445 - 446 - 447 - 448 - 449 - 450 - 451 - 452 - 453 - 454 - 455 - 456 - 457 - 458 - 459 - 460 - 461 - 462 - 463 - 464 - 465 - 466 - 467 - 468 - 469 - 470 - 471 - 472 - 473 - 474 - 475 - 476 - 477 - 478 - 479 - 480 - 481 - 482 - 483 - 484 - 485 - 486 - 487 - 488 - 489 - 490 - 491 - 492 - 493 - 494 - 495 - 496 - 497 - 498 - 499 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 509 - 510 - 511 - 512 - 513 - 514 - 515 - 516 - 517 - 518 - 519 - 520 - 521 - 522 - 523 - 524 - 525 - 526 - 527 - 528 - 529 - 530 - 531 - 532 - 533 - 534 - 535 - 536 - 537 - 538 - 539 - 540 - 541 - 542 - 543 - 544 - 545 - 546 - 547 - 548 - 549 - 550 - 551 - 552 - 553 - 554 - 555 - 556 - 557 - 558 - 559 - 560 - 561 - 562 - 563 - 564 - 565 - 566 - 567 - 568 - 569 - 570 - 571 - 572 - 573 - 574 - 575 - 576 - 577 - 578 - 579 - 580 - 581 - 582 - 583 - 584 - 585 - 586 - 587 - 588 - 589 - 590 - 591 - 592 - 593 - 594 - 595 - 596 - 597 - 598 - 599 - 600 - 601 - 602 - 603 - 604 - 605 - 606 - 607 - 608 - 609 - 610 - 611 - 612 - 613 - 614 - 615 - 616 - 617 - 618 - 619 - 620 - 621 - 622 - 623 - 624 - 625 - 626 - 627 - 628 - 629 - 630 - 631 - 632 - 633 - 634 - 635 - 636 - 637 - 638 - 639 - 640 - 641 - 642 - 643 - 644 - 645 - 646 - 647 - 648 - 649 - 650 - 651 - 652 - 653 - 654 - 655 - 656 - 657 - 658 - 659 - 660 - 661 - 662 - 663 - 664 - 665 - 666 - 667 - 668 - 669 - 670 - 671 - 672 - 673 - 674 - 675 - 676 - 677 - 678 - 679 - 680 - 681 - 682 - 683 - 684 - 685 - 686 - 687 - 688 - 689 - 690 - 691 - 692 - 693 - 694 - 695 - 696 - 697 - 698 - 699 - 700 - 701 - 702 - 703 - 704 - 705 - 706 - 707 - 708 - 709 - 710 - 711 - 712 - 713 - 714 - 715 - 716 - 717 - 718 - 719 - 720 - 721 - 722 - 723 - 724 - 725 - 726 - 727 - 728 - 729 - 730 - 731 - 732 - 733 - 734 - 735 - 736 - 737 - 738 - 739 - 740 - 741 - 742 - 743 - 744 - 745 - 746 - 747 - 748 - 749 - 750 - 751 - 752 - 753 - 754 - 755 - 756 - 757 - 758 - 759 - 760 - 761 - 762 - 763 - 764 - 765 - 766 - 767 - 768 - 769 - 770 - 771 - 772 - 773 - 774 - 775 - 776 - 777 - 778 - 779 - 780 - 781 - 782 - 783 - 784 - 785 - 786 - 787 - 788 - 789 - 790 - 791 - 792 - 793 - 794 - 795 - 796 - 797 - 798 - 799 - 800 - 801 - 802 - 803 - 804 - 805 - 806 - 807 - 808 - 809 - 810 - 811 - 812 - 813 - 814 - 815 - 816 - 817 - 818 - 819 - 820 - 821 - 822 - 823 - 824 - 825 - 826 - 827 - 828 - 829 - 830 - 831 - 832 - 833 - 834 - 835 - 836 - 837 - 838 - 839 - 840 - 841 - 842 - 843 - 844 - 845 - 846 - 847 - 848 - 849 - 850 - 851 - 852 - 853 - 854 - 855 - 856 - 857 - 858 - 859 - 860 - 861 - 862 - 863 - 864 - 865 - 866 - 867 - 868 - 869 - 870 - 871 - 872 - 873 - 874 - 875 - 876 - 877 - 878 - 879 - 880 - 881 - 882 - 883 - 884 - 885 - 886 - 887 - 888 - 889 - 890 - 891 - 892 - 893 - 894 - 895 - 896 - 897 - 898 - 899 - 900 - 901 - 902 - 903 - 904 - 905 - 906 - 907 - 908 - 909 - 910 - 911 - 912 - 913 - 914 - 915 - 916 - 917 - 918 - 919 - 920 - 921 - 922 - 923 - 924 - 925 - 926 - 927 - 928 - 929 - 930 - 931 - 932 - 933 - 934 - 935 - 936 - 937 - 938 - 939 - 940 - 941 - 942 - 943 - 944 - 945 - 946 - 947 - 948 - 949 - 950 - 951 - 952 - 953 - 954 - 955 - 956 - 957 - 958 - 959 - 960 - 961 - 962 - 963 - 964 - 965 - 966 - 967 - 968 - 969 - 970 - 971 - 972 - 973 - 974 - 975 - 976 - 977 - 978 - 979 - 980 - 981 - 982 - 983 - 984 - 985 - 986 - 987 - 988 - 989 - 990 - 991 - 992 - 993 - 994 - 995 - 996 - 997 - 998 - 999 -1000 -1001 -1002 -1003 -1004 -1005 -1006 -1007 -1008 -1009 -1010 -1011 -1012 -1013 -1014 -1015 -1016 -1017 -1018 -1019 -1020 -1021 -1022 -1023 -1024 -1025 -1026 -1027 -1028 -1029 -1030 -1031 -1032 -1033 -1034 -1035 -1036 -1037 -1038 -1039 -1040 -1041 -1042 -1043 -1044 -1045 -1046 -1047 -1048 -1049 -1050 -1051 -1052 -1053 -1054 -1055 -1056 -1057 -1058 -1059 -1060 -1061 -1062 -1063 -1064 -1065 -1066 -1067 -1068 -1069 -1070 -1071 -1072 -1073 -1074 -1075 -1076 -1077 -1078 -1079 -1080 -1081 -1082 -1083 -1084 -1085 -1086 -1087 -1088 -1089 -1090 -1091 -1092 -1093 -1094 -1095 -1096 -1097 -1098 -1099 -1100 -1101 -1102 -1103 -1104 -1105 -1106 -1107 -1108 -1109 -1110 -1111 -1112 -1113 -1114 -1115 -1116 -1117 -1118 -1119 -1120 -1121 -1122 -1123 -1124 -1125 -1126 -1127 -1128 -1129 -1130 -1131 -1132 -1133 -1134 -1135 -1136 -1137 -1138 -1139 -1140 -1141 -1142 -1143 -1144 -1145 -1146 -1147 -1148 -1149 -1150 -1151 -1152 -1153 -1154 -1155 -1156 -1157 -1158 -1159 -1160 -1161 -1162 -1163 -1164 -1165 -1166 -1167 -1168 -1169 -1170 -1171 -1172 -1173 -1174 -1175 -1176 -1177 -1178 -1179 -1180 -1181 -1182 -1183 -1184 -1185 -1186 -1187 -1188 -1189 -1190 -1191 -1192 -1193 -1194 -1195 -1196 -1197 -1198 -1199 -1200 -1201 -1202 -1203 -1204 -1205 -1206 -1207 -1208 -1209 -1210 -1211 -1212 -1213 -1214 -1215 -1216 -1217 -1218 -1219 -1220 -1221 -1222 -1223 -1224 -1225 -1226 -1227 -1228 -1229 -1230 -1231 -1232 -1233 -1234 -1235 -1236 -1237 -1238 -1239 -1240 -1241 -1242 -1243 -1244 -1245 -1246 -1247 -1248 -1249 -1250 -1251 -1252 -1253 -1254 -1255 -1256 -1257 -1258 -1259 -1260 -1261 -1262 -1263 -1264 -1265 -1266 -1267 -1268 -1269 -1270 -1271 -1272 -1273 -1274 -1275 -1276 -1277 -1278 -1279 -1280 -1281 -1282 -1283 -1284 -1285 -1286 -1287 -1288 -1289 -1290 -1291 -1292 -1293 -1294 -1295 -1296 -1297 -1298 -1299 -1300 -1301 -1302 -1303 -1304 -1305 -1306 -1307 -1308 -1309 -1310 -1311 -1312 -1313 -1314 -1315 -1316 -1317 -1318 -1319 -1320 -1321 -1322 -1323 -1324 -1325 -1326 -1327 -1328 -1329 -1330 -1331 -1332 -1333 -1334 -1335 -1336 -1337 -1338 -1339 -1340 -1341 -1342 -1343 -1344 -1345 -1346 -1347 -1348 -1349 -1350 -1351 -1352 -1353 -1354 -1355 -1356 -1357 -1358 -1359 -1360 -1361 -1362 -1363 -1364 -1365 -1366 -1367 -1368 -1369 -1370 -1371 -1372 -1373 -1374 -1375 -1376 -1377 -1378 -1379 -1380 -1381 -1382 -1383 -1384 -1385 -1386 -1387 -1388 -1389 -1390 -1391 -1392 -1393 -1394 -1395 -1396 -1397 -1398 -1399 -1400 -1401 -1402 -1403 -1404 -1405 -1406 -1407 -1408 -1409 -1410 -1411 -1412 -1413 -1414 -1415 -1416 -1417 -1418 -1419 -1420 -1421 -1422 -1423 -1424 -1425 -1426 -1427 -1428 -1429 -1430 -1431 -1432 -1433 -1434 -1435 -1436 -1437 -1438 -1439 -1440 -1441 -1442 -1443 -1444 -1445 -1446 -1447 -1448 -1449 -1450 -1451 -1452 -1453 -1454 -1455 -1456 -1457 -1458 -1459 -1460 -1461 -1462 -1463 -1464 -1465 -1466 -1467 -1468 -1469 -1470 -1471 -1472 -1473 -1474 -1475 -1476 -1477 -1478 -1479 -1480 -1481 -1482 -1483 -1484 -1485 -1486 -1487 -1488 -1489 -1490 -1491 -1492 -1493 -1494 -1495 -1496 -1497 -1498 -1499 -1500 -1501 -1502 -1503 -1504 -1505 -1506 -1507 -1508 -1509 -1510 -1511 -1512 -1513 -1514 -1515 -1516 -1517 -1518 -1519 -1520 -1521 -1522 -1523 -1524 -1525 -1526 -1527 -1528 -1529 -1530 -1531 -1532 -1533 -1534 -1535 -1536 -1537 -1538 -1539 -1540 -1541 -1542 -1543 -1544 -1545 -1546 -1547 -1548 -1549 -1550 -1551 -1552 -1553 -1554 -1555 -1556 -1557 -1558 -1559 -1560 -1561 -1562 -1563 -1564 -1565 -1566 -1567 -1568 -1569 -1570 -1571 -1572 -1573 -1574 -1575 -1576 -1577 -1578 -1579 -1580 -1581 -1582 -1583 -1584 -1585 -1586 -1587 -1588 -1589 -1590 -1591 -1592 -1593 -1594 -1595 -1596 -1597 -1598 -1599 -1600 -1601 -1602 -1603 -1604 -1605 -1606 -1607 -1608 -1609 -1610 -1611 -1612 -1613 -1614 -1615 -1616 -1617 -1618 -1619 -1620 -1621 -1622 -1623 -1624 -1625 -1626 -1627 -1628 -1629 -1630 -1631 -1632 -1633 -1634 -1635 -1636 -1637 -1638 -1639 -1640 -1641 -1642 -1643 -1644 -1645 -1646 -1647 -1648 -1649 -1650 -1651 -1652 -1653 -1654 -1655 -1656 -1657 -1658 -1659 -1660 -1661 -1662 -1663 -1664 -1665 -1666 -1667 -1668 -1669 -1670 -1671 -1672 -1673 -1674 -1675 -1676 -1677 -1678 -1679 -1680 -1681 -1682 -1683 -1684 -1685 -1686 -1687 -1688 -1689 -1690 -1691 -1692 -1693 -1694 -1695 -1696 -1697 -1698 -1699 -1700 -1701 -1702 -1703 -1704 -1705 -1706 -1707 -1708 -1709 -1710 -1711 -1712 -1713 -1714 -1715 -1716 -1717 -1718 -1719 -1720 -1721 -1722 -1723 -1724 -1725 -1726 -1727 -1728 -1729 -1730 -1731 -1732 -1733 -1734 -1735 -1736 -1737 -1738 -1739 -1740 -1741 -1742 -1743 -1744 -1745 -1746 -1747 -1748 -1749 -1750 -1751 -1752 -1753 -1754 -1755 -1756 -1757 -1758 -1759 -1760 -1761 -1762 -1763 -1764 -1765 -1766 -1767 -1768 -1769 -1770 -1771 -1772 -1773 -1774 -1775 -1776 -1777 -1778 -1779 -1780 -1781 -1782 -1783 -1784 -1785 -1786 -1787 -1788 -1789 -1790 -1791 -1792 -1793 -1794 -1795 -1796 -1797 -1798 -1799 -1800 -1801 -1802 -1803 -1804 -1805 -1806 -1807 -1808 -1809 -1810 -1811 -1812 -1813 -1814 -1815 -1816 -1817 -1818 -1819 -1820 -1821 -1822 -1823 -1824 -1825 -1826 -1827 -1828 -1829 -1830 -1831 -1832 -1833 -1834 -1835 -1836 -1837 -1838 -1839 -1840 -1841 -1842 -1843 -1844 -1845 -1846 -1847 -1848 -1849 -1850 -1851 -1852 -1853 -1854 -1855 -1856 -1857 -1858 -1859 -1860 -1861 -1862 -1863 -1864 -1865 -1866 -1867 -1868 -1869 -1870 -1871 -1872 -1873 -1874 -1875 -1876 -1877 -1878 -1879 -1880 -1881 -1882 -1883 -1884 -1885 -1886 -1887 -1888 -1889 -1890 -1891 -1892 -1893 -1894 -1895 -1896 -1897 -1898 -1899 -1900 -1901 -1902 -1903 -1904 -1905 -1906 -1907 -1908 -1909 -1910 -1911 -1912 -1913 -1914 -1915 -1916 -1917 -1918 -1919 -1920 -1921 -1922 -1923 -1924 -1925 -1926 -1927 -1928 -1929 -1930 -1931 -1932 -1933 -1934 -1935 -1936 -1937 -1938 -1939 -1940 -1941 -1942 -1943 -1944 -1945 -1946 -1947 -1948 -1949 -1950 -1951 -1952 -1953 -1954 -1955 -1956 -1957 -1958 -1959 -1960 -1961 -1962 -1963 -1964 -1965 -1966 -1967 -1968 -1969 -1970 -1971 -1972 -1973 -1974 -1975 -1976 -1977 -1978 -1979 -1980 -1981 -1982 -1983 -1984 -1985 -1986 -1987 -1988 -1989 -1990 -1991 -1992 -1993 -1994 -1995 -1996 -1997 -1998 -1999 -2000 -2001 -2002 -2003 -2004 -2005 -2006 -2007 -2008 -2009 -2010 -2011 -2012 -2013 -2014 -2015 -2016 -2017 -2018 -2019 -2020 -2021 -2022 -2023 -2024 -2025 -2026 -2027 -2028 -2029 -2030 -2031 -2032 -2033 -2034 -2035 -2036 -2037 -2038 -2039 -2040 -2041 -2042 -2043 -2044 -2045 -2046 -2047 -2048 -2049 -2050 -2051 -2052 -2053 -2054 -2055 -2056 -2057 -2058 -2059 -2060 -2061 -2062 -2063 -2064 -2065 -2066 -2067 -2068 -2069 -2070 -2071 -2072 -2073 -2074 -2075 -2076 -2077 -2078 -2079 -2080 -2081 -2082 -2083 -2084 -2085 -2086 -2087 -2088 -2089 -2090 -2091 -2092 -2093 -2094 -2095 -2096 -2097 -2098 -2099 -2100 -2101 -2102 -2103 -2104 -2105 -2106 -2107 -2108 -2109 -2110 -2111 -2112 -2113 -2114 -2115 -2116 -2117 -2118 -2119 -2120 -2121 -2122 -2123 -2124 -2125 -2126 -2127 -2128 -2129 -2130 -2131 -2132 -2133 -2134 -2135 -2136 -2137 -2138 -2139 -2140 -2141 -2142 -2143 -2144 -2145 -2146 -2147 -2148 -2149 -2150 -2151 -2152 -2153 -2154 -2155 -2156 -2157 -2158 -2159 -2160 -2161 -2162 -2163 -2164 -2165 -2166 -2167 -2168 -2169 -2170 -2171 -2172 -2173 -2174 -2175 -2176 -2177 -2178 -2179 -2180 -2181 -2182 -2183 -2184 -2185 -2186 -2187 -2188 -2189 -2190 -2191 -2192 -2193 -2194 -2195 -2196 -2197 -2198 -2199 -2200 -2201 -2202 -2203 -2204 -2205 -2206 -2207 -2208 -2209 -2210 -2211 -2212 -2213 -2214 -2215 -2216 -2217 -2218 -2219 -2220 -2221 -2222 -2223 -2224 -2225 -2226 -2227 -2228 -2229 -2230 -2231 -2232 -2233 -2234 -2235 -2236 -2237 -2238 -2239 -2240 -2241 -2242 -2243 -2244 -2245 -2246 -2247 -2248 -2249 -2250 -2251 -2252 -2253 -2254 -2255 -2256 -2257 -2258 -2259 -2260 -2261 -2262 -2263 -2264 -2265 -2266 -2267 -2268 -2269 -2270 -2271 -2272 -2273 -2274 -2275 -2276 -2277 -2278 -2279 -2280 -2281 -2282 -2283 -2284 -2285 -2286 -2287 -2288 -2289 -2290 -2291 -2292 -2293 -2294 -2295 -2296 -2297 -2298 -2299 -2300 -2301 -2302 -2303 -2304 -2305 -2306 -2307 -2308 -2309 -2310 -2311 -2312 -2313 -2314 -2315 -2316 -2317 -2318 -2319 -2320 -2321 -2322 -2323 -2324 -2325 -2326 -2327 -2328 -2329 -2330 -2331 -2332 -2333 -2334 -2335 -2336 -2337 -2338 -2339 -2340 -2341 -2342 -2343 -2344 -2345 -2346 -2347 -2348 -2349 -2350 -2351 -2352 -2353 -2354 -2355 -2356 -2357 -2358 -2359 -2360 -2361 -2362 -2363 -2364 -2365 -2366 -2367 -2368 -2369 -2370 -2371 -2372 -2373 -2374 -2375 -2376 -2377 -2378 -2379 -2380 -2381 -2382 -2383 -2384 -2385 -2386 -2387 -2388 -2389 -2390 -2391 -2392 -2393 -2394 -2395 -2396 -2397 -2398 -2399 -2400 -2401 -2402 -2403 -2404 -2405 -2406 -2407 -2408 -2409 -2410 -2411 -2412 -2413 -2414 -2415 -2416 -2417 -2418 -2419 -2420 -2421 -2422 -2423 -2424 -2425 -2426 -2427 -2428 -2429 -2430 -2431 -2432 -2433 -2434 -2435 -2436 -2437 -2438 -2439 -2440 -2441 -2442 -2443 -2444 -2445 -2446 -2447 -2448 -2449 -2450 -2451 -2452 -2453 -2454 -2455 -2456 -2457 -2458 -2459 -2460 -2461 -2462 -2463 -2464 -2465 -2466 -2467 -2468 -2469 -2470 -2471 -2472 -2473 -2474 -2475 -2476 -2477 -2478 -2479 -2480 -2481 -2482 -2483 -2484 -2485 -2486 -2487 -2488 -2489 -2490 -2491 -2492 -2493 -2494 -2495 -2496 -2497 -2498 -2499 -2500 -2501 -2502 -2503 -2504 -2505 -2506 -2507 -2508 -2509 -2510 -2511 -2512 -2513 -2514 -2515 -2516 -2517 -2518 -2519 -2520 -2521 -2522 -2523 -2524 -2525 -2526 -2527 -2528 -2529 -2530 -2531 -2532 -2533 -2534 -2535 -2536 -2537 -2538 -2539 -2540 -2541 -2542 -2543 -2544 -2545 -2546 -2547 -2548 -2549 -2550 -2551 -2552 -2553 -2554 -2555 -2556 -2557 -2558 -2559 -2560 -2561 -2562 -2563 -2564 -2565 -2566 -2567 -2568 -2569 -2570 -2571 -2572 -2573 -2574 -2575 -2576 -2577 -2578 -2579 -2580 -2581 -2582 -2583 -2584 -2585 -2586 -2587 -2588 -2589 -2590 -2591 -2592 -2593 -2594 -2595 -2596 -2597 -2598 -2599 -2600 -2601 -2602 -2603 -2604 -2605 -2606 -2607 -2608 -2609 -2610 -2611 -2612 -2613 -2614 -2615 -2616 -2617 -2618 -2619 -2620 -2621 -2622 -2623 -2624 -2625 -2626 -2627 -2628 -2629 -2630 -2631 -2632 -2633 -2634 -2635 -2636 -2637 -2638 -2639 -2640 -2641 -2642 -2643 -2644 -2645 -2646 -2647 -2648 -2649 -2650 -2651 -2652 -2653 -2654 -2655 -2656 -2657 -2658 -2659 -2660 -2661 -2662 -2663 -2664 -2665 -2666 -2667 -2668 -2669 -2670 -2671 -2672 -2673 -2674 -2675 -2676 -2677 -2678 -2679 -2680 -2681 -2682 -2683 -2684 -2685 -2686 -2687 -2688 -2689 -2690 -2691 -2692 -2693 -2694 -2695 -2696 -2697 -2698 -2699 -2700 -2701 -2702 -2703 -2704 -2705 -2706 -2707 -2708 -2709 -2710 -2711 -2712 -2713 -2714 -2715 -2716 -2717 -2718 -2719 -2720 -2721 -2722 -2723 -2724 -2725 -2726 -2727 -2728 -2729 -2730 -2731 -2732 -2733 -2734 -2735 -2736 -2737 -2738 -2739 -2740 -2741 -2742 -2743 -2744 -2745 -2746 -2747 -2748 -2749 -2750 -2751 -2752 -2753 -2754 -2755 -2756 -2757 -2758 -2759 -2760 -2761 -2762 -2763 -2764 -2765 -2766 -2767 -2768 -2769 -2770 -2771 -2772 -2773 -2774 -2775 -2776 -2777 -2778 -2779 -2780 -2781 -2782 -2783 -2784 -2785 -2786 -2787 -2788 -2789 -2790 -2791 -2792 -2793 -2794 -2795 -2796 -2797 -2798 -2799 -2800 -2801 -2802 -2803 -2804 -2805 -2806 -2807 -2808 -2809 -2810 -2811 -2812 -2813 -2814 -2815 -2816 -2817 -2818 -2819 -2820 -2821 -2822 -2823 -2824 -2825 -2826 -2827 -2828 -2829 -2830 -2831 -2832 -2833 -2834 -2835 -2836 -2837 -2838 -2839 -2840 -2841 -2842 -2843 -2844 -2845 -2846 -2847 -2848 -2849 -2850 -2851 -2852 -2853 -2854 -2855 -2856 -2857 -2858 -2859 -2860 -2861 -2862 -2863 -2864 -2865 -2866 -2867 -2868 -2869 -2870 -2871 -2872 -2873 -2874 -2875 -2876 -2877 -2878 -2879 -2880 -2881 -2882 -2883 -2884 -2885 -2886 -2887 -2888 -2889 -2890 -2891 -2892 -2893 -2894 -2895 -2896 -2897 -2898 -2899 -2900 -2901 -2902 -2903 -2904 -2905 -2906 -2907 -2908 -2909 -2910 -2911 -2912 -2913 -2914 -2915 -2916 -2917 -2918 -2919 -2920 -2921 -2922 -2923 -2924 -2925 -2926 -2927 -2928 -2929 -2930 -2931 -2932 -2933 -2934 -2935 -2936 -2937 -2938 -2939 -2940 -2941 -2942 -2943 -2944 -2945 -2946 -2947 -2948 -2949 -2950 -2951 -2952 -2953 -2954 -2955 -2956 -2957 -2958 -2959 -2960 -2961 -2962 -2963 -2964 -2965 -2966 -2967 -2968 -2969 -2970 -2971 -2972 -2973 -2974 -2975 -2976 -2977 -2978 -2979 -2980 -2981 -2982 -2983 -2984 -2985 -2986 -2987 -2988 -2989 -2990 -2991 -2992 -2993 -2994 -2995 -2996 -2997 -2998 -2999 -3000 -3001 -3002 -3003 -3004 -3005 -3006 -3007 -3008 -3009 -3010 -3011 -3012 -3013 -3014 -3015 -3016 -3017 -3018 -3019 -3020 -3021 -3022 -3023 -3024 -3025 -3026 -3027 -3028 -3029 -3030 -3031 -3032 -3033 -3034 -3035 -3036 -3037 -3038 -3039 -3040 -3041 -3042 -3043 -3044 -3045 -3046 -3047 -3048 -3049 -3050 -3051 -3052 -3053 -3054 -3055 -3056 -3057 -3058 -3059 -3060 -3061 -3062 -3063 -3064 -3065 -3066 -3067 -3068 -3069 -3070 -3071 -3072 -3073 -3074 -3075 -3076 -3077 -3078 -3079 -3080 -3081 -3082 -3083 -3084 -3085 -3086 -3087 -3088 -3089 -3090 -3091 -3092 -3093 -3094 -3095 -3096 -3097 -3098 -3099 -3100 -3101 -3102 -3103 -3104 -3105 -3106 -3107 -3108 -3109 -3110 -3111 -3112 -3113 -3114 -3115 -3116 -3117 -3118 -3119 -3120 -3121 -3122 -3123 -3124 -3125 -3126 -3127 -3128 -3129 -3130 -3131 -3132 -3133 -3134 -3135 -3136 -3137 -3138 -3139 -3140 -3141 -3142 -3143 -3144 -3145 -3146 -3147 -3148 -3149 -3150 -3151 -3152 -3153 -3154 -3155 -3156 -3157 -3158 -3159 -3160 -3161 -3162 -3163 -3164 -3165 -3166 -3167 -3168 -3169 -3170 -3171 -3172 -3173 -3174 -3175 -3176 -3177 -3178 -3179 -3180 -3181 -3182 -3183 -3184 -3185 -3186 -3187 -3188 -3189 -3190 -3191 -3192 -3193 -3194 -3195 -3196 -3197 -3198 -3199 -3200 -3201 -3202 -3203 -3204 -3205 -3206 -3207 -3208 -3209 -3210 -3211 -3212 -3213 -3214 -3215 -3216 -3217 -3218 -3219 -3220 -3221 -3222 -3223 -3224 -3225 -3226 -3227 -3228 -3229 -3230 -3231 -3232 -3233 -3234 -3235 -3236 -3237 -3238 -3239 -3240 -3241 -3242 -3243 -3244 -3245 -3246 -3247 -3248 -3249 -3250 -3251 -3252 -3253 -3254 -3255 -3256 -3257 -3258 -3259 -3260 -3261 -3262 -3263 -3264 -3265 -3266 -3267 -3268 -3269 -3270 -3271 -3272 -3273 -3274 -3275 -3276 -3277 -3278 -3279 -3280 -3281 -3282 -3283 -3284 -3285 -3286 -3287 -3288 -3289 -3290 -3291 -3292 -3293 -3294 -3295 -3296 -3297 -3298 -3299 -3300 -3301 -3302 -3303 -3304 -3305 -3306 -3307 -3308 -3309 -3310 -3311 -3312 -3313 -3314 -3315 -3316 -3317 -3318 -3319 -3320 -3321 -3322 -3323 -3324 -3325 -3326 -3327 -3328 -3329 -3330 -3331 -3332 -3333 -3334 -3335 -3336 -3337 -3338 -3339 -3340 -3341 -3342 -3343 -3344 -3345 -3346 -3347 -3348 -3349 -3350 -3351 -3352 -3353 -3354 -3355 -3356 -3357 -3358 -3359 -3360 -3361 -3362 -3363 -3364 -3365 -3366 -3367 -3368 -3369 -3370 -3371 -3372 -3373 -3374 -3375 -3376 -3377 -3378 -3379 -3380 -3381 -3382 -3383 -3384 -3385 -3386 -3387 -3388 -3389 -3390 -3391 -3392 -3393 -3394 -3395 -3396 -3397 -3398 -3399 -3400 -3401 -3402 -3403 -3404 -3405 -3406 -3407 -3408 -3409 -3410 -3411 -3412 -3413 -3414 -3415 -3416 -3417 -3418 -3419 -3420 -3421 -3422 -3423 -3424 -3425 -3426 -3427 -3428 -3429 -3430 -3431 -3432 -3433 -3434 -3435 -3436 -3437 -3438 -3439 -3440 -3441 -3442 -3443 -3444 -3445 -3446 -3447 -3448 -3449 -3450 -3451 -3452 -3453 -3454 -3455 -3456 -3457 -3458 -3459 -3460 -3461 -3462 -3463 -3464 -3465 -3466 -3467 -3468 -3469 -3470 -3471 -3472 -3473 -3474 -3475 -3476 -3477 -3478 -3479 -3480 -3481 -3482 -3483 -3484 -3485 -3486 -3487 -3488 -3489 -3490 -3491 -3492 -3493 -3494 -3495 -3496 -3497 -3498 -3499 -3500 -3501 -3502 -3503 -3504 -3505 -3506 -3507 -3508 -3509 -3510 -3511 -3512 -3513 -3514 -3515 -3516 -3517 -3518 -3519 -3520 -3521 -3522 -3523 -3524 -3525 -3526 -3527 -3528 -3529 -3530 -3531 -3532 -3533 -3534 -3535 -3536 -3537 -3538 -3539 -3540 -3541 -3542 -3543 -3544 -3545 -3546 -3547 -3548 -3549 -3550 -3551 -3552 -3553 -3554 -3555 -3556 -3557 -3558 -3559 -3560 -3561 -3562 -3563 -3564 -3565 -3566 -3567 -3568 -3569 -3570 -3571 -3572 -3573 -3574 -3575 -3576 -3577 -3578 -3579 -3580 -3581 -3582 -3583 -3584 -3585 -3586 -3587 -3588 -3589 -3590 -3591 -3592 -3593 -3594 -3595 -3596 -3597 -3598 -3599 -3600 -3601 -3602 -3603 -3604 -3605 -3606 -3607 -3608 -3609 -3610 -3611 -3612 -3613 -3614 -3615 -3616 -3617 -3618 -3619 -3620 -3621 -3622 -3623 -3624 -3625 -3626 -3627 -3628 -3629 -3630 -3631 -3632 -3633 -3634 -3635 -3636 -3637 -3638 -3639 -3640 -3641 -3642 -3643 -3644 -3645 -3646 -3647 -3648 -3649 -3650 -3651 -3652 -3653 -3654 -3655 -3656 -3657 -3658 -3659 -3660 -3661 -3662 -3663 -3664 -3665 -3666 -3667 -3668 -3669 -3670 -3671 -3672 -3673 -3674 -3675 -3676 -3677 -3678 -3679 -3680 -3681 -3682 -3683 -3684 -3685 -3686 -3687 -3688 -3689 -3690 -3691 -3692 -3693 -3694 -3695 -3696 -3697 -3698 -3699 -3700 -3701 -3702 -3703 -3704 -3705 -3706 -3707 -3708 -3709 -3710 -3711 -3712 -3713 -3714 -3715 -3716 -3717 -3718 -3719 -3720 -3721 -3722 -3723 -3724 -3725 -3726 -3727 -3728 -3729 -3730 -3731 -3732 -3733 -3734 -3735 -3736 -3737 -3738 -3739 -3740 -3741 -3742 -3743 -3744 -3745 -3746 -3747 -3748 -3749 -3750 -3751 -3752 -3753 -3754 -3755 -3756 -3757 -3758 -3759 -3760 -3761 -3762 -3763 -3764 -3765 -3766 -3767 -3768 -3769 -3770 -3771 -3772 -3773 -3774 -3775 -3776 -3777 -3778 -3779 -3780 -3781 -3782 -3783 -3784 -3785 -3786 -3787 -3788 -3789 -3790 -3791 -3792 -3793 -3794 -3795 -3796 -3797 -3798 -3799 -3800 -3801 -3802 -3803 -3804 -3805 -3806 -3807 -3808 -3809 -3810 -3811 -3812 -3813 -3814 -3815 -3816 -3817 -3818 -3819 -3820 -3821 -3822 -3823 -3824 -3825 -3826 -3827 -3828 -3829 -3830 -3831 -3832 -3833 -3834 -3835 -3836 -
//!
-//! [](https://crates.io/crates/ubits)
-//! [](https://crates.io/crates/ubits)
-//! [](https://github.com/manoadamro/ubits/actions/workflows/rust.yml)
-//! [](https://manoadamro.github.io/ubits/doc/ubits/)
-//! [](https://github.com/manoadamro/ubits/blob/main/LICENSE)
-//!
-//! Bit fields and masks for rust!
-//!
-//! Provides a macro for generating [`bit field`](https://en.wikipedia.org/wiki/Bit_field) types
-//! complete with flags and some helpful trait implementations.
-//!
-//! Supports field widths of `8`, `16`, `32`, `64` and `128` bits.
-//!
-//! - [`bitfield`] - macro documentation.
-//! - [`examples`] - examples of the output generated by the [`bitfield`] macro.
-//!
-//! __Note: the example module is only complied with documentation builds
-//! and is not available for importing in the wild.__
-//!
-//!
-//! # Usage
-//!
-//! Generate a bitfield struct with a flag enum...
-//! (The following examples all use this as a definition.)
-//! ```rust
-//! use ubits::bitfield;
-//!
-//! bitfield! {
-//! pub u8 ExampleField
-//! ExampleFlags {
-//! 0 : Flag0,
-//! 1 : Flag1,
-//! 2 : Flag2,
-//! 3 : Flag3,
-//! 4 : Flag4,
-//! 5 : Flag5,
-//! 6 : Flag6,
-//! 7 : Flag7,
-//! }
-//! }
-//! ```
-//!
-//! ## Instances
-//!
-//! From integer:
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let from_integer = ExampleField(123);
-//! assert_eq!(ExampleField(123), from_integer);
-//! ```
-//!
-//! From a binary string:
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let from_binary = ExampleField::from_binary_str("01111011");
-//! assert_eq!(ExampleField(123), from_binary)
-//! ```
-//!
-//! From ones:
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let from_ones = ExampleField::ones();
-//! assert_eq!("11111111", from_ones.as_binary());
-//! assert_eq!(255, from_ones.as_integer());
-//! ```
-//!
-//! From zeros:
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let from_zeros = ExampleField::zeros();
-//! assert_eq!("00000000", from_zeros.as_binary());
-//! assert_eq!(0, from_zeros.as_integer());
-//! ```
-//!
-//! ### Field Access
-//!
-//! Get bit value by field:
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let field = ExampleField::from_binary_str("01010101");
-//! assert!(field.get(ExampleFlags::Flag0));
-//! assert!(!field.get(ExampleFlags::Flag1));
-//! ```
-//!
-//! Get bit value by index:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let field = ExampleField::from_binary_str("01010101");
-//! assert!(field.get_index(0));
-//! assert!(!field.get_index(1));
-//! ```
-//!
-//! Set bit value by field:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! field.set(ExampleFlags::Flag1);
-//! field.set(ExampleFlags::Flag3);
-//! assert_eq!("01011111", field.as_binary());
-//! ```
-//!
-//! Set bit value by index:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! field.set_index(1);
-//! field.set_index(3);
-//! assert_eq!("01011111", field.as_binary());
-//! ```
-//!
-//! Clear bit value by field:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! field.clear(ExampleFlags::Flag0);
-//! field.clear(ExampleFlags::Flag2);
-//! assert_eq!("01010000", field.as_binary());
-//! ```
-//!
-//! Clear bit value by index:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! field.clear_index(0);
-//! field.clear_index(2);
-//! assert_eq!("01010000", field.as_binary());
-//! ```
-//!
-//! Toggle bit value by field:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! field.toggle(ExampleFlags::Flag0);
-//! assert_eq!("01010100", field.as_binary());
-//! field.toggle(ExampleFlags::Flag0);
-//! assert_eq!("01010101", field.as_binary());
-//! ```
-//!
-//! Toggle bit value by index:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! field.toggle_index(0);
-//! assert_eq!("01010100", field.as_binary());
-//! field.toggle_index(0);
-//! assert_eq!("01010101", field.as_binary());
-//! ```
-//!
-//! ### Named Getters and Setters
-//!
-//! Ubits can generate getter and setter methods for zero or more fields, if a name is provided.
-//!
-//! ```rust
-//! use ubits::bitfield;
-//! bitfield! {
-//! pub u8 ExampleField
-//! ExampleFlags {
-//! 0 : Flag0 : (field_0), // is_field_0 & set_field_0 & clear_field_0 & toggle_field_0
-//! 1 : Flag1 : (field_1), // is_field_1 & set_field_1 & clear_field_1 & toggle_field_1
-//! 2 : Flag2,
-//! 3 : Flag3,
-//! 4 : Flag4,
-//! 5 : Flag5,
-//! 6 : Flag6,
-//! 7 : Flag7,
-//! }
-//! }
-//!
-//! let mut field = ExampleField::from_binary_str("01010101");
-//! assert_eq!(true, field.is_field_0());
-//! assert_eq!(false, field.is_field_1());
-//!
-//! field.set_field_1();
-//! assert_eq!(true, field.is_field_1());
-//!
-//! field.clear_field_1();
-//! assert_eq!(false, field.is_field_1());
-//!
-//! field.toggle_field_1();
-//! assert_eq!(true, field.is_field_1());
-//! ```
-//!
-//! ### Combinations
-//!
-//! Combine bit fields: <br>
-//! (use `into_combined` to consume self)
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut a = ExampleField::from_binary_str("01010101");
-//! let b = ExampleField::from_binary_str("10101010");
-//! assert_eq!("11111111", a.combine(b).as_binary());
-//! ```
-//!
-//! Get the intersection of two bitfields: <br>
-//! (use `into_intersection` to consume self)
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut a = ExampleField::from_binary_str("11000011");
-//! let b = ExampleField::from_binary_str("01111110");
-//! assert_eq!("01000010", a.intersect(b).as_binary());
-//! ```
-//!
-//! Get the diff of two bitfields: <br>
-//! (use `into_diff` to consume self)
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut a = ExampleField::from_binary_str("11000011");
-//! let b = ExampleField::from_binary_str("01100110");
-//! assert_eq!("10100101", a.diff(b).as_binary());
-//! ```
-//!
-//! ### Bitwise
-//!
-//! Both bit field instances and flags use bitwise operators to change bit values.
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut from_zeros = ExampleField::zeros();
-//! assert_eq!("00000000", from_zeros.as_binary());
-//!
-//! // set bit to 1
-//! from_zeros |= ExampleFlags::Flag1;
-//! assert_eq!("00000010", from_zeros.as_binary());
-//!
-//! // set bit back to 0
-//! from_zeros &= ExampleFlags::Flag1;
-//! assert_eq!("00000000", from_zeros.as_binary());
-//!
-//! // toggle a bit
-//! from_zeros ^= ExampleFlags::Flag1;
-//! assert_eq!("00000010", from_zeros.as_binary());
-//!
-//! from_zeros ^= ExampleFlags::Flag1;
-//! assert_eq!("00000000", from_zeros.as_binary());
-//! ```
-//!
-//! Operations can also be chained together:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut from_zeros = ExampleField::zeros() | ExampleFlags::Flag1 | ExampleFlags::Flag3;
-//! assert_eq!("00001010", from_zeros.as_binary());
-//!
-//! ```
-//!
-//! Bitfield instances can also be created from combining flags:
-//!
-//! ```rust
-//! # use ubits::bitfield;
-//! # bitfield! {
-//! # pub u8 ExampleField
-//! # ExampleFlags {
-//! # 0 : Flag0,
-//! # 1 : Flag1,
-//! # 2 : Flag2,
-//! # 3 : Flag3,
-//! # 4 : Flag4,
-//! # 5 : Flag5,
-//! # 6 : Flag6,
-//! # 7 : Flag7,
-//! # }
-//! # }
-//!
-//! let mut from_zeros = ExampleFlags::Flag1 | ExampleFlags::Flag3;
-//! assert_eq!("00001010", from_zeros.as_binary());
-//!
-//! ```
-//!
-//! ## Fields named with flags
-//!
-//! The generated flags enum allows you to access bits by name.
-//! The flag has an associated [`u8`] value,
-//! which determines the index its target bit.
-//! (See [`bitfield`] for more info)
-//!
-//! With the following input...
-//! ```no_compile
-//! 1 0 1 0 0 1 1 0
-//! ```
-//!
-//! and the following flags...
-//! ```no_compile
-//! 0 : f1
-//! 1 : f1
-//! 2 : f2
-//! 3 : f3
-//! 4 : f4
-//! 5 : f5
-//! 6 : f6
-//! 7 : f7
-//! ```
-//!
-//! we end up with this layout.
-//!
-//! | name | f7 | f6 | f5 | f4 | f3 | f2 | f1 | f0 |
-//! |-----------|----|----|----|----|----|----|----|----|
-//! | bit value | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 0 |
-//! | index | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
-//!
-//!
-//! With the same input and only the first few flags:
-//!
-//! ```no_compile
-//! 0 : f0
-//! 1 : f1
-//! 2 : f2
-//! ```
-//!
-//! we end up with this layout.
-//!
-//! | name | | | | | | f2 | f1 | f0 |
-//! |-----------|----|----|----|----|----|----|----|----|
-//! | bit value | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 0 |
-//! | index | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
-//!
-//!
-//! Using the same input, but with dispersed flags:
-//!
-//! ```no_compile
-//! 1 : f0
-//! 3 : f1
-//! 6 : f2
-//! ```
-//!
-//! we end up with this layout.
-//!
-//! | name | | f2 | | | f1 | | f0 | |
-//! |-----------|----|----|----|----|----|----|----|----|
-//! | bit value | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 0 |
-//! | index | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
-//!
-
-// -------------------------------------------------------------------------------------------------
-// Imports
-
-extern crate doc_comment;
-extern crate paste;
-extern crate safe_transmute;
-
-#[doc(hidden)]
-pub use doc_comment::doc_comment as __doc_comment;
-
-#[doc(hidden)]
-pub use safe_transmute::{
- transmute_one as __transmute_one, TriviallyTransmutable as __TriviallyTransmutable,
+lib.rs - source 1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
+806
+807
+808
+809
+810
+811
+812
+813
+814
+815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
+826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
+856
+857
+858
+859
+860
+861
+862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
+883
+884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
+946
+947
+948
+949
+950
+951
+952
+953
+954
+955
+956
+957
+958
+959
+960
+961
+962
+963
+964
+965
+966
+967
+968
+969
+970
+971
+972
+973
+974
+975
+976
+977
+978
+979
+980
+981
+982
+983
+984
+985
+986
+987
+988
+989
+990
+991
+992
+993
+994
+995
+996
+997
+998
+999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
+1100
+1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
+1169
+1170
+1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
+1193
+1194
+1195
+1196
+1197
+1198
+1199
+1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
+1233
+1234
+1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
+1258
+1259
+1260
+1261
+1262
+1263
+1264
+1265
+1266
+1267
+1268
+1269
+1270
+1271
+1272
+1273
+1274
+1275
+1276
+1277
+1278
+1279
+1280
+1281
+1282
+1283
+1284
+1285
+1286
+1287
+1288
+1289
+1290
+1291
+1292
+1293
+1294
+1295
+1296
+1297
+1298
+1299
+1300
+1301
+1302
+1303
+1304
+1305
+1306
+1307
+1308
+1309
+1310
+1311
+1312
+1313
+1314
+1315
+1316
+1317
+1318
+1319
+1320
+1321
+1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
+1409
+1410
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
+1420
+1421
+1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
+1448
+1449
+1450
+1451
+1452
+1453
+1454
+1455
+1456
+1457
+1458
+1459
+1460
+1461
+1462
+1463
+1464
+1465
+1466
+1467
+1468
+1469
+1470
+1471
+1472
+1473
+1474
+1475
+1476
+1477
+1478
+1479
+1480
+1481
+1482
+1483
+1484
+1485
+1486
+1487
+1488
+1489
+1490
+1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
+1506
+1507
+1508
+1509
+1510
+1511
+1512
+1513
+1514
+1515
+1516
+1517
+1518
+1519
+1520
+1521
+1522
+1523
+1524
+1525
+1526
+1527
+1528
+1529
+1530
+1531
+1532
+1533
+1534
+1535
+1536
+1537
+1538
+1539
+1540
+1541
+1542
+1543
+1544
+1545
+1546
+1547
+1548
+1549
+1550
+1551
+1552
+1553
+1554
+1555
+1556
+1557
+1558
+1559
+1560
+1561
+1562
+1563
+1564
+1565
+1566
+1567
+1568
+1569
+1570
+1571
+1572
+1573
+1574
+1575
+1576
+1577
+1578
+1579
+1580
+1581
+1582
+1583
+1584
+1585
+1586
+1587
+1588
+1589
+1590
+1591
+1592
+1593
+1594
+1595
+1596
+1597
+1598
+1599
+1600
+1601
+1602
+1603
+1604
+1605
+1606
+1607
+1608
+1609
+1610
+1611
+1612
+1613
+1614
+1615
+1616
+1617
+1618
+1619
+1620
+1621
+1622
+1623
+1624
+1625
+1626
+1627
+1628
+1629
+1630
+1631
+1632
+1633
+1634
+1635
+1636
+1637
+1638
+1639
+1640
+1641
+1642
+1643
+1644
+1645
+1646
+1647
+1648
+1649
+1650
+1651
+1652
+1653
+1654
+1655
+1656
+1657
+1658
+1659
+1660
+1661
+1662
+1663
+1664
+1665
+1666
+1667
+1668
+1669
+1670
+1671
+1672
+1673
+1674
+1675
+1676
+1677
+1678
+1679
+1680
+1681
+1682
+1683
+1684
+1685
+1686
+1687
+1688
+1689
+1690
+1691
+1692
+1693
+1694
+1695
+1696
+1697
+1698
+1699
+1700
+1701
+1702
+1703
+1704
+1705
+1706
+1707
+1708
+1709
+1710
+1711
+1712
+1713
+1714
+1715
+1716
+1717
+1718
+1719
+1720
+1721
+1722
+1723
+1724
+1725
+1726
+1727
+1728
+1729
+1730
+1731
+1732
+1733
+1734
+1735
+1736
+1737
+1738
+1739
+1740
+1741
+1742
+1743
+1744
+1745
+1746
+1747
+1748
+1749
+1750
+1751
+1752
+1753
+1754
+1755
+1756
+1757
+1758
+1759
+1760
+1761
+1762
+1763
+1764
+1765
+1766
+1767
+1768
+1769
+1770
+1771
+1772
+1773
+1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
+1787
+1788
+1789
+1790
+1791
+1792
+1793
+1794
+1795
+1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
+1805
+1806
+1807
+1808
+1809
+1810
+1811
+1812
+1813
+1814
+1815
+1816
+1817
+1818
+1819
+1820
+1821
+1822
+1823
+1824
+1825
+1826
+1827
+1828
+1829
+1830
+1831
+1832
+1833
+1834
+1835
+1836
+1837
+1838
+1839
+1840
+1841
+1842
+1843
+1844
+1845
+1846
+1847
+1848
+1849
+1850
+1851
+1852
+1853
+1854
+1855
+1856
+1857
+1858
+1859
+1860
+1861
+1862
+1863
+1864
+1865
+1866
+1867
+1868
+1869
+1870
+1871
+1872
+1873
+1874
+1875
+1876
+1877
+1878
+1879
+1880
+1881
+1882
+1883
+1884
+1885
+1886
+1887
+1888
+1889
+1890
+1891
+1892
+1893
+1894
+1895
+1896
+1897
+1898
+1899
+1900
+1901
+1902
+1903
+1904
+1905
+1906
+1907
+1908
+1909
+1910
+1911
+1912
+1913
+1914
+1915
+1916
+1917
+1918
+1919
+1920
+1921
+1922
+1923
+1924
+1925
+1926
+1927
+1928
+1929
+1930
+1931
+1932
+1933
+1934
+1935
+1936
+1937
+1938
+1939
+1940
+1941
+1942
+1943
+1944
+1945
+1946
+1947
+1948
+1949
+1950
+1951
+1952
+1953
+1954
+1955
+1956
+1957
+1958
+1959
+1960
+1961
+1962
+1963
+1964
+1965
+1966
+1967
+1968
+1969
+1970
+1971
+1972
+1973
+1974
+1975
+1976
+1977
+1978
+1979
+1980
+1981
+1982
+1983
+1984
+1985
+1986
+1987
+1988
+1989
+1990
+1991
+1992
+1993
+1994
+1995
+1996
+1997
+1998
+1999
+2000
+2001
+2002
+2003
+2004
+2005
+2006
+2007
+2008
+2009
+2010
+2011
+2012
+2013
+2014
+2015
+2016
+2017
+2018
+2019
+2020
+2021
+2022
+2023
+2024
+2025
+2026
+2027
+2028
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
+2043
+2044
+2045
+2046
+2047
+2048
+2049
+2050
+2051
+2052
+2053
+2054
+2055
+2056
+2057
+2058
+2059
+2060
+2061
+2062
+2063
+2064
+2065
+2066
+2067
+2068
+2069
+2070
+2071
+2072
+2073
+2074
+2075
+2076
+2077
+2078
+2079
+2080
+2081
+2082
+2083
+2084
+2085
+2086
+2087
+2088
+2089
+2090
+2091
+2092
+2093
+2094
+2095
+2096
+2097
+2098
+2099
+2100
+2101
+2102
+2103
+2104
+2105
+2106
+2107
+2108
+2109
+2110
+2111
+2112
+2113
+2114
+2115
+2116
+2117
+2118
+2119
+2120
+2121
+2122
+2123
+2124
+2125
+2126
+2127
+2128
+2129
+2130
+2131
+2132
+2133
+2134
+2135
+2136
+2137
+2138
+2139
+2140
+2141
+2142
+2143
+2144
+2145
+2146
+2147
+2148
+2149
+2150
+2151
+2152
+2153
+2154
+2155
+2156
+2157
+2158
+2159
+2160
+2161
+2162
+2163
+2164
+2165
+2166
+2167
+2168
+2169
+2170
+2171
+2172
+2173
+2174
+2175
+2176
+2177
+2178
+2179
+2180
+2181
+2182
+2183
+2184
+2185
+2186
+2187
+2188
+2189
+2190
+2191
+2192
+2193
+2194
+2195
+2196
+2197
+2198
+2199
+2200
+2201
+2202
+2203
+2204
+2205
+2206
+2207
+2208
+2209
+2210
+2211
+2212
+2213
+2214
+2215
+2216
+2217
+2218
+2219
+2220
+2221
+2222
+2223
+2224
+2225
+2226
+2227
+2228
+2229
+2230
+2231
+2232
+2233
+2234
+2235
+2236
+2237
+2238
+2239
+2240
+2241
+2242
+2243
+2244
+2245
+2246
+2247
+2248
+2249
+2250
+2251
+2252
+2253
+2254
+2255
+2256
+2257
+2258
+2259
+2260
+2261
+2262
+2263
+2264
+2265
+2266
+2267
+2268
+2269
+2270
+2271
+2272
+2273
+2274
+2275
+2276
+2277
+2278
+2279
+2280
+2281
+2282
+2283
+2284
+2285
+2286
+2287
+2288
+2289
+2290
+2291
+2292
+2293
+2294
+2295
+2296
+2297
+2298
+2299
+2300
+2301
+2302
+2303
+2304
+2305
+2306
+2307
+2308
+2309
+2310
+2311
+2312
+2313
+2314
+2315
+2316
+2317
+2318
+2319
+2320
+2321
+2322
+2323
+2324
+2325
+2326
+2327
+2328
+2329
+2330
+2331
+2332
+2333
+2334
+2335
+2336
+2337
+2338
+2339
+2340
+2341
+2342
+2343
+2344
+2345
+2346
+2347
+2348
+2349
+2350
+2351
+2352
+2353
+2354
+2355
+2356
+2357
+2358
+2359
+2360
+2361
+2362
+2363
+2364
+2365
+2366
+2367
+2368
+2369
+2370
+2371
+2372
+2373
+2374
+2375
+2376
+2377
+2378
+2379
+2380
+2381
+2382
+2383
+2384
+2385
+2386
+2387
+2388
+2389
+2390
+2391
+2392
+2393
+2394
+2395
+2396
+2397
+2398
+2399
+2400
+2401
+2402
+2403
+2404
+2405
+2406
+2407
+2408
+2409
+2410
+2411
+2412
+2413
+2414
+2415
+2416
+2417
+2418
+2419
+2420
+2421
+2422
+2423
+2424
+2425
+2426
+2427
+2428
+2429
+2430
+2431
+2432
+2433
+2434
+2435
+2436
+2437
+2438
+2439
+2440
+2441
+2442
+2443
+2444
+2445
+2446
+2447
+2448
+2449
+2450
+2451
+2452
+2453
+2454
+2455
+2456
+2457
+2458
+2459
+2460
+2461
+2462
+2463
+2464
+2465
+2466
+2467
+2468
+2469
+2470
+2471
+2472
+2473
+2474
+2475
+2476
+2477
+2478
+2479
+2480
+2481
+2482
+2483
+2484
+2485
+2486
+2487
+2488
+2489
+2490
+2491
+2492
+2493
+2494
+2495
+2496
+2497
+2498
+2499
+2500
+2501
+2502
+2503
+2504
+2505
+2506
+2507
+2508
+2509
+2510
+2511
+2512
+2513
+2514
+2515
+2516
+2517
+2518
+2519
+2520
+2521
+2522
+2523
+2524
+2525
+2526
+2527
+2528
+2529
+2530
+2531
+2532
+2533
+2534
+2535
+2536
+2537
+2538
+2539
+2540
+2541
+2542
+2543
+2544
+2545
+2546
+2547
+2548
+2549
+2550
+2551
+2552
+2553
+2554
+2555
+2556
+2557
+2558
+2559
+2560
+2561
+2562
+2563
+2564
+2565
+2566
+2567
+2568
+2569
+2570
+2571
+2572
+2573
+2574
+2575
+2576
+2577
+2578
+2579
+2580
+2581
+2582
+2583
+2584
+2585
+2586
+2587
+2588
+2589
+2590
+2591
+2592
+2593
+2594
+2595
+2596
+2597
+2598
+2599
+2600
+2601
+2602
+2603
+2604
+2605
+2606
+2607
+2608
+2609
+2610
+2611
+2612
+2613
+2614
+2615
+2616
+2617
+2618
+2619
+2620
+2621
+2622
+2623
+2624
+2625
+2626
+2627
+2628
+2629
+2630
+2631
+2632
+2633
+2634
+2635
+2636
+2637
+2638
+2639
+2640
+2641
+2642
+2643
+2644
+2645
+2646
+2647
+2648
+2649
+2650
+2651
+2652
+2653
+2654
+2655
+2656
+2657
+2658
+2659
+2660
+2661
+2662
+2663
+2664
+2665
+2666
+2667
+2668
+2669
+2670
+2671
+2672
+2673
+2674
+2675
+2676
+2677
+2678
+2679
+2680
+2681
+2682
+2683
+2684
+2685
+2686
+2687
+2688
+2689
+2690
+2691
+2692
+2693
+2694
+2695
+2696
+2697
+2698
+2699
+2700
+2701
+2702
+2703
+2704
+2705
+2706
+2707
+2708
+2709
+2710
+2711
+2712
+2713
+2714
+2715
+2716
+2717
+2718
+2719
+2720
+2721
+2722
+2723
+2724
+2725
+2726
+2727
+2728
+2729
+2730
+2731
+2732
+2733
+2734
+2735
+2736
+2737
+2738
+2739
+2740
+2741
+2742
+2743
+2744
+2745
+2746
+2747
+2748
+2749
+2750
+2751
+2752
+2753
+2754
+2755
+2756
+2757
+2758
+2759
+2760
+2761
+2762
+2763
+2764
+2765
+2766
+2767
+2768
+2769
+2770
+2771
+2772
+2773
+2774
+2775
+2776
+2777
+2778
+2779
+2780
+2781
+2782
+2783
+2784
+2785
+2786
+2787
+2788
+2789
+2790
+2791
+2792
+2793
+2794
+2795
+2796
+2797
+2798
+2799
+2800
+2801
+2802
+2803
+2804
+2805
+2806
+2807
+2808
+2809
+2810
+2811
+2812
+2813
+2814
+2815
+2816
+2817
+2818
+2819
+2820
+2821
+2822
+2823
+2824
+2825
+2826
+2827
+2828
+2829
+2830
+2831
+2832
+2833
+2834
+2835
+2836
+2837
+2838
+2839
+2840
+2841
+2842
+2843
+2844
+2845
+2846
+2847
+2848
+2849
+2850
+2851
+2852
+2853
+2854
+2855
+2856
+2857
+2858
+2859
+2860
+2861
+2862
+2863
+2864
+2865
+2866
+2867
+2868
+2869
+2870
+2871
+2872
+2873
+2874
+2875
+2876
+2877
+2878
+2879
+2880
+2881
+2882
+2883
+2884
+2885
+2886
+2887
+2888
+2889
+2890
+2891
+2892
+2893
+2894
+2895
+2896
+2897
+2898
+2899
+2900
+2901
+2902
+2903
+2904
+2905
+2906
+2907
+2908
+2909
+2910
+2911
+2912
+2913
+2914
+2915
+2916
+2917
+2918
+2919
+2920
+2921
+2922
+2923
+2924
+2925
+2926
+2927
+2928
+2929
+2930
+2931
+2932
+2933
+2934
+2935
+2936
+2937
+2938
+2939
+2940
+2941
+2942
+2943
+2944
+2945
+2946
+2947
+2948
+2949
+2950
+2951
+2952
+2953
+2954
+2955
+2956
+2957
+2958
+2959
+2960
+2961
+2962
+2963
+2964
+2965
+2966
+2967
+2968
+2969
+2970
+2971
+2972
+2973
+2974
+2975
+2976
+2977
+2978
+2979
+2980
+2981
+2982
+2983
+2984
+2985
+2986
+2987
+2988
+2989
+2990
+2991
+2992
+2993
+2994
+2995
+2996
+2997
+2998
+2999
+3000
+3001
+3002
+3003
+3004
+3005
+3006
+3007
+3008
+3009
+3010
+3011
+3012
+3013
+3014
+3015
+3016
+3017
+3018
+3019
+3020
+3021
+3022
+3023
+3024
+3025
+3026
+3027
+3028
+3029
+3030
+3031
+3032
+3033
+3034
+3035
+3036
+3037
+3038
+3039
+3040
+3041
+3042
+3043
+3044
+3045
+3046
+3047
+3048
+3049
+3050
+3051
+3052
+3053
+3054
+3055
+3056
+3057
+3058
+3059
+3060
+3061
+3062
+3063
+3064
+3065
+3066
+3067
+3068
+3069
+3070
+3071
+3072
+3073
+3074
+3075
+3076
+3077
+3078
+3079
+3080
+3081
+3082
+3083
+3084
+3085
+3086
+3087
+3088
+3089
+3090
+3091
+3092
+3093
+3094
+3095
+3096
+3097
+3098
+3099
+3100
+3101
+3102
+3103
+3104
+3105
+3106
+3107
+3108
+3109
+3110
+3111
+3112
+3113
+3114
+3115
+3116
+3117
+3118
+3119
+3120
+3121
+3122
+3123
+3124
+3125
+3126
+3127
+3128
+3129
+3130
+3131
+3132
+3133
+3134
+3135
+3136
+3137
+3138
+3139
+3140
+3141
+3142
+3143
+3144
+3145
+3146
+3147
+3148
+3149
+3150
+3151
+3152
+3153
+3154
+3155
+3156
+3157
+3158
+3159
+3160
+3161
+3162
+3163
+3164
+3165
+3166
+3167
+3168
+3169
+3170
+3171
+3172
+3173
+3174
+3175
+3176
+3177
+3178
+3179
+3180
+3181
+3182
+3183
+3184
+3185
+3186
+3187
+3188
+3189
+3190
+3191
+3192
+3193
+3194
+3195
+3196
+3197
+3198
+3199
+3200
+3201
+3202
+3203
+3204
+3205
+3206
+3207
+3208
+3209
+3210
+3211
+3212
+3213
+3214
+3215
+3216
+3217
+3218
+3219
+3220
+3221
+3222
+3223
+3224
+3225
+3226
+3227
+3228
+3229
+3230
+3231
+3232
+3233
+3234
+3235
+3236
+3237
+3238
+3239
+3240
+3241
+3242
+3243
+3244
+3245
+3246
+3247
+3248
+3249
+3250
+3251
+3252
+3253
+3254
+3255
+3256
+3257
+3258
+3259
+3260
+3261
+3262
+3263
+3264
+3265
+3266
+3267
+3268
+3269
+3270
+3271
+3272
+3273
+3274
+3275
+3276
+3277
+3278
+3279
+3280
+3281
+3282
+3283
+3284
+3285
+3286
+3287
+3288
+3289
+3290
+3291
+3292
+3293
+3294
+3295
+3296
+3297
+3298
+3299
+3300
+3301
+3302
+3303
+3304
+3305
+3306
+3307
+3308
+3309
+3310
+3311
+3312
+3313
+3314
+3315
+3316
+3317
+3318
+3319
+3320
+3321
+3322
+3323
+3324
+3325
+3326
+3327
+3328
+3329
+3330
+3331
+3332
+3333
+3334
+3335
+3336
+3337
+3338
+3339
+3340
+3341
+3342
+3343
+3344
+3345
+3346
+3347
+3348
+3349
+3350
+3351
+3352
+3353
+3354
+3355
+3356
+3357
+3358
+3359
+3360
+3361
+3362
+3363
+3364
+3365
+3366
+3367
+3368
+3369
+3370
+3371
+3372
+3373
+3374
+3375
+3376
+3377
+3378
+3379
+3380
+3381
+3382
+3383
+3384
+3385
+3386
+3387
+3388
+3389
+3390
+3391
+3392
+3393
+3394
+3395
+3396
+3397
+3398
+3399
+3400
+3401
+3402
+3403
+3404
+3405
+3406
+3407
+3408
+3409
+3410
+3411
+3412
+3413
+3414
+3415
+3416
+3417
+3418
+3419
+3420
+3421
+3422
+3423
+3424
+3425
+3426
+3427
+3428
+3429
+3430
+3431
+3432
+3433
+3434
+3435
+3436
+3437
+3438
+3439
+3440
+3441
+3442
+3443
+3444
+3445
+3446
+3447
+3448
+3449
+3450
+3451
+3452
+3453
+3454
+3455
+3456
+3457
+3458
+3459
+3460
+3461
+3462
+3463
+3464
+3465
+3466
+3467
+3468
+3469
+3470
+3471
+3472
+3473
+3474
+3475
+3476
+3477
+3478
+3479
+3480
+3481
+3482
+3483
+3484
+3485
+3486
+3487
+3488
+3489
+3490
+3491
+3492
+3493
+3494
+3495
+3496
+3497
+3498
+3499
+3500
+3501
+3502
+3503
+3504
+3505
+3506
+3507
+3508
+3509
+3510
+3511
+3512
+3513
+3514
+3515
+3516
+3517
+3518
+3519
+3520
+3521
+3522
+3523
+3524
+3525
+3526
+3527
+3528
+3529
+3530
+3531
+3532
+3533
+3534
+3535
+3536
+3537
+3538
+3539
+3540
+3541
+3542
+3543
+3544
+3545
+3546
+3547
+3548
+3549
+3550
+3551
+3552
+3553
+3554
+3555
+3556
+3557
+3558
+3559
+3560
+3561
+3562
+3563
+3564
+3565
+3566
+3567
+3568
+3569
+3570
+3571
+3572
+3573
+3574
+3575
+3576
+3577
+3578
+3579
+3580
+3581
+3582
+3583
+3584
+3585
+3586
+3587
+3588
+3589
+3590
+3591
+3592
+3593
+3594
+3595
+3596
+3597
+3598
+3599
+3600
+3601
+3602
+3603
+3604
+3605
+3606
+3607
+3608
+3609
+3610
+3611
+3612
+3613
+3614
+3615
+3616
+3617
+3618
+3619
+3620
+3621
+3622
+3623
+3624
+3625
+3626
+3627
+3628
+3629
+3630
+3631
+3632
+3633
+3634
+3635
+3636
+3637
+3638
+3639
+3640
+3641
+3642
+3643
+3644
+3645
+3646
+3647
+3648
+3649
+3650
+3651
+3652
+3653
+3654
+3655
+3656
+3657
+3658
+3659
+3660
+3661
+3662
+3663
+3664
+3665
+3666
+3667
+3668
+3669
+3670
+3671
+3672
+3673
+3674
+3675
+3676
+3677
+3678
+3679
+3680
+3681
+3682
+3683
+3684
+3685
+3686
+3687
+3688
+3689
+3690
+3691
+3692
+3693
+3694
+3695
+3696
+3697
+3698
+3699
+3700
+3701
+3702
+3703
+3704
+3705
+3706
+3707
+3708
+3709
+3710
+3711
+3712
+3713
+3714
+3715
+3716
+3717
+3718
+3719
+3720
+3721
+3722
+3723
+3724
+3725
+3726
+3727
+3728
+3729
+3730
+3731
+3732
+3733
+3734
+3735
+3736
+3737
+3738
+3739
+3740
+3741
+3742
+3743
+3744
+3745
+3746
+3747
+3748
+3749
+3750
+3751
+3752
+3753
+3754
+3755
+3756
+3757
+3758
+3759
+3760
+3761
+3762
+3763
+3764
+3765
+3766
+3767
+3768
+3769
+3770
+3771
+3772
+3773
+3774
+3775
+3776
+3777
+3778
+3779
+3780
+3781
+3782
+3783
+3784
+3785
+3786
+3787
+3788
+3789
+3790
+3791
+3792
+3793
+3794
+3795
+3796
+3797
+3798
+3799
+3800
+3801
+3802
+3803
+3804
+3805
+3806
+3807
+3808
+3809
+3810
+3811
+3812
+3813
+3814
+3815
+3816
+3817
+3818
+3819
+3820
+3821
+3822
+3823
+3824
+3825
+3826
+3827
+3828
+3829
+3830
+3831
+3832
+3833
+3834
+3835
+3836
+
//!
+//! [](https://crates.io/crates/ubits)
+//! [](https://crates.io/crates/ubits)
+//! [](https://github.com/manoadamro/ubits/actions/workflows/rust.yml)
+//! [](https://manoadamro.github.io/ubits/doc/ubits/)
+//! [](https://github.com/manoadamro/ubits/blob/main/LICENSE)
+//!
+//! Bit fields and masks for rust!
+//!
+//! Provides a macro for generating [`bit field`](https://en.wikipedia.org/wiki/Bit_field) types
+//! complete with flags and some helpful trait implementations.
+//!
+//! Supports field widths of `8`, `16`, `32`, `64` and `128` bits.
+//!
+//! - [`bitfield`] - macro documentation.
+//! - [`examples`] - examples of the output generated by the [`bitfield`] macro.
+//!
+//! __Note: the example module is only complied with documentation builds
+//! and is not available for importing in the wild.__
+//!
+//!
+//! # Usage
+//!
+//! Generate a bitfield struct with a flag enum...
+//! (The following examples all use this as a definition.)
+//! ```rust
+//! use ubits::bitfield;
+//!
+//! bitfield! {
+//! pub u8 ExampleField
+//! ExampleFlags {
+//! 0 : Flag0,
+//! 1 : Flag1,
+//! 2 : Flag2,
+//! 3 : Flag3,
+//! 4 : Flag4,
+//! 5 : Flag5,
+//! 6 : Flag6,
+//! 7 : Flag7,
+//! }
+//! }
+//! ```
+//!
+//! ## Instances
+//!
+//! From integer:
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let from_integer = ExampleField(123);
+//! assert_eq!(ExampleField(123), from_integer);
+//! ```
+//!
+//! From a binary string:
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let from_binary = ExampleField::from_binary_str("01111011");
+//! assert_eq!(ExampleField(123), from_binary)
+//! ```
+//!
+//! From ones:
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let from_ones = ExampleField::ones();
+//! assert_eq!("11111111", from_ones.as_binary());
+//! assert_eq!(255, from_ones.as_integer());
+//! ```
+//!
+//! From zeros:
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let from_zeros = ExampleField::zeros();
+//! assert_eq!("00000000", from_zeros.as_binary());
+//! assert_eq!(0, from_zeros.as_integer());
+//! ```
+//!
+//! ### Field Access
+//!
+//! Get bit value by field:
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let field = ExampleField::from_binary_str("01010101");
+//! assert!(field.get(ExampleFlags::Flag0));
+//! assert!(!field.get(ExampleFlags::Flag1));
+//! ```
+//!
+//! Get bit value by index:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let field = ExampleField::from_binary_str("01010101");
+//! assert!(field.get_index(0));
+//! assert!(!field.get_index(1));
+//! ```
+//!
+//! Set bit value by field:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! field.set(ExampleFlags::Flag1);
+//! field.set(ExampleFlags::Flag3);
+//! assert_eq!("01011111", field.as_binary());
+//! ```
+//!
+//! Set bit value by index:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! field.set_index(1);
+//! field.set_index(3);
+//! assert_eq!("01011111", field.as_binary());
+//! ```
+//!
+//! Clear bit value by field:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! field.clear(ExampleFlags::Flag0);
+//! field.clear(ExampleFlags::Flag2);
+//! assert_eq!("01010000", field.as_binary());
+//! ```
+//!
+//! Clear bit value by index:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! field.clear_index(0);
+//! field.clear_index(2);
+//! assert_eq!("01010000", field.as_binary());
+//! ```
+//!
+//! Toggle bit value by field:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! field.toggle(ExampleFlags::Flag0);
+//! assert_eq!("01010100", field.as_binary());
+//! field.toggle(ExampleFlags::Flag0);
+//! assert_eq!("01010101", field.as_binary());
+//! ```
+//!
+//! Toggle bit value by index:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! field.toggle_index(0);
+//! assert_eq!("01010100", field.as_binary());
+//! field.toggle_index(0);
+//! assert_eq!("01010101", field.as_binary());
+//! ```
+//!
+//! ### Named Getters and Setters
+//!
+//! Ubits can generate getter and setter methods for zero or more fields, if a name is provided.
+//!
+//! ```rust
+//! use ubits::bitfield;
+//! bitfield! {
+//! pub u8 ExampleField
+//! ExampleFlags {
+//! 0 : Flag0 : (field_0), // is_field_0 & set_field_0 & clear_field_0 & toggle_field_0
+//! 1 : Flag1 : (field_1), // is_field_1 & set_field_1 & clear_field_1 & toggle_field_1
+//! 2 : Flag2,
+//! 3 : Flag3,
+//! 4 : Flag4,
+//! 5 : Flag5,
+//! 6 : Flag6,
+//! 7 : Flag7,
+//! }
+//! }
+//!
+//! let mut field = ExampleField::from_binary_str("01010101");
+//! assert_eq!(true, field.is_field_0());
+//! assert_eq!(false, field.is_field_1());
+//!
+//! field.set_field_1();
+//! assert_eq!(true, field.is_field_1());
+//!
+//! field.clear_field_1();
+//! assert_eq!(false, field.is_field_1());
+//!
+//! field.toggle_field_1();
+//! assert_eq!(true, field.is_field_1());
+//! ```
+//!
+//! ### Combinations
+//!
+//! Combine bit fields: <br>
+//! (use `into_combined` to consume self)
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut a = ExampleField::from_binary_str("01010101");
+//! let b = ExampleField::from_binary_str("10101010");
+//! assert_eq!("11111111", a.combine(b).as_binary());
+//! ```
+//!
+//! Get the intersection of two bitfields: <br>
+//! (use `into_intersection` to consume self)
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut a = ExampleField::from_binary_str("11000011");
+//! let b = ExampleField::from_binary_str("01111110");
+//! assert_eq!("01000010", a.intersect(b).as_binary());
+//! ```
+//!
+//! Get the diff of two bitfields: <br>
+//! (use `into_diff` to consume self)
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut a = ExampleField::from_binary_str("11000011");
+//! let b = ExampleField::from_binary_str("01100110");
+//! assert_eq!("10100101", a.diff(b).as_binary());
+//! ```
+//!
+//! ### Bitwise
+//!
+//! Both bit field instances and flags use bitwise operators to change bit values.
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut from_zeros = ExampleField::zeros();
+//! assert_eq!("00000000", from_zeros.as_binary());
+//!
+//! // set bit to 1
+//! from_zeros |= ExampleFlags::Flag1;
+//! assert_eq!("00000010", from_zeros.as_binary());
+//!
+//! // set bit back to 0
+//! from_zeros &= ExampleFlags::Flag1;
+//! assert_eq!("00000000", from_zeros.as_binary());
+//!
+//! // toggle a bit
+//! from_zeros ^= ExampleFlags::Flag1;
+//! assert_eq!("00000010", from_zeros.as_binary());
+//!
+//! from_zeros ^= ExampleFlags::Flag1;
+//! assert_eq!("00000000", from_zeros.as_binary());
+//! ```
+//!
+//! Operations can also be chained together:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut from_zeros = ExampleField::zeros() | ExampleFlags::Flag1 | ExampleFlags::Flag3;
+//! assert_eq!("00001010", from_zeros.as_binary());
+//!
+//! ```
+//!
+//! Bitfield instances can also be created from combining flags:
+//!
+//! ```rust
+//! # use ubits::bitfield;
+//! # bitfield! {
+//! # pub u8 ExampleField
+//! # ExampleFlags {
+//! # 0 : Flag0,
+//! # 1 : Flag1,
+//! # 2 : Flag2,
+//! # 3 : Flag3,
+//! # 4 : Flag4,
+//! # 5 : Flag5,
+//! # 6 : Flag6,
+//! # 7 : Flag7,
+//! # }
+//! # }
+//!
+//! let mut from_zeros = ExampleFlags::Flag1 | ExampleFlags::Flag3;
+//! assert_eq!("00001010", from_zeros.as_binary());
+//!
+//! ```
+//!
+//! ## Fields named with flags
+//!
+//! The generated flags enum allows you to access bits by name.
+//! The flag has an associated [`u8`] value,
+//! which determines the index its target bit.
+//! (See [`bitfield`] for more info)
+//!
+//! With the following input...
+//! ```no_compile
+//! 1 0 1 0 0 1 1 0
+//! ```
+//!
+//! and the following flags...
+//! ```no_compile
+//! 0 : f1
+//! 1 : f1
+//! 2 : f2
+//! 3 : f3
+//! 4 : f4
+//! 5 : f5
+//! 6 : f6
+//! 7 : f7
+//! ```
+//!
+//! we end up with this layout.
+//!
+//! | name | f7 | f6 | f5 | f4 | f3 | f2 | f1 | f0 |
+//! |-----------|----|----|----|----|----|----|----|----|
+//! | bit value | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 0 |
+//! | index | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+//!
+//!
+//! With the same input and only the first few flags:
+//!
+//! ```no_compile
+//! 0 : f0
+//! 1 : f1
+//! 2 : f2
+//! ```
+//!
+//! we end up with this layout.
+//!
+//! | name | | | | | | f2 | f1 | f0 |
+//! |-----------|----|----|----|----|----|----|----|----|
+//! | bit value | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 0 |
+//! | index | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+//!
+//!
+//! Using the same input, but with dispersed flags:
+//!
+//! ```no_compile
+//! 1 : f0
+//! 3 : f1
+//! 6 : f2
+//! ```
+//!
+//! we end up with this layout.
+//!
+//! | name | | f2 | | | f1 | | f0 | |
+//! |-----------|----|----|----|----|----|----|----|----|
+//! | bit value | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 0 |
+//! | index | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+//!
+
+// -------------------------------------------------------------------------------------------------
+// Imports
+
+extern crate doc_comment;
+extern crate paste;
+extern crate safe_transmute;
+
+#[doc(hidden)]
+pub use doc_comment::doc_comment as __doc_comment;
+
+#[doc(hidden)]
+pub use safe_transmute::{
+ transmute_one as __transmute_one, TriviallyTransmutable as __TriviallyTransmutable,
};
-#[doc(hidden)]
-pub use paste::paste as __paste;
-
-// -------------------------------------------------------------------------------------------------
-// Generator Macros
-
-/// Generates a bitfield struct and a corresponding flag enum.
-///
-/// Can be used multiple times in a single codebase
-/// as long as the identifiers are unique or are isolated so as not to clash.
-///
-/// __See the [`examples`] module for examples of the generated output.__
-///
-/// # Args
-///
-/// - `pub` - optional accessor: if provided, both generated items will public.
-/// If omitted, both will be private. <br>
-/// [see here](https://doc.rust-lang.org/reference/visibility-and-privacy.html#visibility-and-privacy) for possible visibility options.
-///
-/// - `ExampleField` - name for the generated bitfield struct.
-/// (results in `struct ExampleField(...)`)
-///
-/// - `ExampleFlags` - name for the generated flag enum.
-/// (results in `enum ExampleFlags { ... }`)
-///
-/// - `u8` - unsigned integer type to use as a bit array. *Must be an unsigned integer* <br>
-/// valid options are: [`u8`],[`u16`], [`u32`], [`u64`], [`u128`], [`usize`]
-///
-/// - `0 : Flag0` - defines each member of the flag enum. <br>
-/// The left hand side must be a [`u8`] `(0..=254)`
-/// and must be less than the number of bits in the underlying unsigned type.
-/// This value determines the index of the target bit within the field. <br>
-/// The right hand side can be any valid identifier (unique to this enum).
-/// These identifiers will be used to access the corresponding field.
-///
-/// - `/// docstrings` - Each element can take optional docstrings.
-/// This includes the bit field struct, the flag enum, and each member within the flag enum.
-/// See [`examples`] for more information.
-///
-/// # Examples:
-///
-/// Full Example - (see below for explanation for each parameter):
-/// ```rust
-/// use ubits::bitfield;
-///
-/// bitfield! {
-/// /// Optional docstring
-/// /// for [`ExampleField`] struct
-/// pub u8 ExampleField
-/// /// Optional docstring
-/// /// for [`ExampleFlags`] enum
-/// ExampleFlags {
-/// /// Optional docstring for [`ExampleFlags::Flag0`]
-/// 0 : Flag0,
-/// /// Optional docstring for [`ExampleFlags::Flag1`]
-/// 1 : Flag1,
-/// /// Optional docstring for [`ExampleFlags::Flag2`]
-/// 2 : Flag2,
-/// /// Optional docstring for [`ExampleFlags::Flag3`]
-/// 3 : Flag3,
-/// /// Optional docstring for [`ExampleFlags::Flag4`]
-/// 4 : Flag4,
-/// /// Optional docstring for [`ExampleFlags::Flag5`]
-/// 5 : Flag5,
-/// /// Optional docstring for [`ExampleFlags::Flag6`]
-/// 6 : Flag6,
-/// /// Optional docstring for [`ExampleFlags::Flag7`]
-/// 7 : Flag7,
-/// }
-/// }
-/// ```
-///
-/// You don't have to name *all* the fields if you don't need them...
-///
-/// You can use just a few from the front:
-/// ```rust
-/// use ubits::bitfield;
-///
-/// bitfield! {
-/// /// Optional docstring
-/// /// for [`ExampleField`] struct
-/// pub u8 ExampleField
-/// /// Optional docstring
-/// /// for [`ExampleFlags`] enum
-/// ExampleFlags {
-/// /// Optional docstring for [`ExampleFlags::Flag0`]
-/// 0 : Flag0,
-/// /// Optional docstring for [`ExampleFlags::Flag1`]
-/// 1 : Flag1,
-/// /// Optional docstring for [`ExampleFlags::Flag2`]
-/// 2 : Flag2,
-/// }
-/// }
-/// ```
-///
-/// ... or any valid indices:
-/// ```rust
-/// use ubits::bitfield;
-///
-/// bitfield! {
-/// /// Optional docstring
-/// /// for [`ExampleField`] struct
-/// pub u8 ExampleField
-/// /// Optional docstring
-/// /// for [`ExampleFlags`] enum
-/// ExampleFlags {
-/// /// Optional docstring for [`ExampleFlags::Flag0`]
-/// 0 : Flag0,
-/// /// Optional docstring for [`ExampleFlags::Flag1`]
-/// 3 : Flag1,
-/// /// Optional docstring for [`ExampleFlags::Flag2`]
-/// 6 : Flag2,
-/// }
-/// }
-/// ```
-/// ... or just omit the flags altogether and use indices only.:
-/// ```rust
-/// use ubits::bitfield;
-/// bitfield! {
-/// /// Optional docstring
-/// /// for [`ExampleField`] struct
-/// pub u8 ExampleField
-/// }
-/// ```
-/// __Note: if you omit flags, no flag enum will be generated
-/// and no methods for the bitfield struct that rely on flags will be generated.__
-///
-#[macro_export(local_inner_macros)]
-macro_rules! bitfield {
-
- // U8
- (
- $(#[$doc:meta])*
- $access:vis u8 $name:ident
+#[doc(hidden)]
+pub use paste::paste as __paste;
+
+// -------------------------------------------------------------------------------------------------
+// Generator Macros
+
+/// Generates a bitfield struct and a corresponding flag enum.
+///
+/// Can be used multiple times in a single codebase
+/// as long as the identifiers are unique or are isolated so as not to clash.
+///
+/// __See the [`examples`] module for examples of the generated output.__
+///
+/// # Args
+///
+/// - `pub` - optional accessor: if provided, both generated items will public.
+/// If omitted, both will be private. <br>
+/// [see here](https://doc.rust-lang.org/reference/visibility-and-privacy.html#visibility-and-privacy) for possible visibility options.
+///
+/// - `ExampleField` - name for the generated bitfield struct.
+/// (results in `struct ExampleField(...)`)
+///
+/// - `ExampleFlags` - name for the generated flag enum.
+/// (results in `enum ExampleFlags { ... }`)
+///
+/// - `u8` - unsigned integer type to use as a bit array. *Must be an unsigned integer* <br>
+/// valid options are: [`u8`],[`u16`], [`u32`], [`u64`], [`u128`], [`usize`]
+///
+/// - `0 : Flag0` - defines each member of the flag enum. <br>
+/// The left hand side must be a [`u8`] `(0..=254)`
+/// and must be less than the number of bits in the underlying unsigned type.
+/// This value determines the index of the target bit within the field. <br>
+/// The right hand side can be any valid identifier (unique to this enum).
+/// These identifiers will be used to access the corresponding field.
+///
+/// - `/// docstrings` - Each element can take optional docstrings.
+/// This includes the bit field struct, the flag enum, and each member within the flag enum.
+/// See [`examples`] for more information.
+///
+/// # Examples:
+///
+/// Full Example - (see below for explanation for each parameter):
+/// ```rust
+/// use ubits::bitfield;
+///
+/// bitfield! {
+/// /// Optional docstring
+/// /// for [`ExampleField`] struct
+/// pub u8 ExampleField
+/// /// Optional docstring
+/// /// for [`ExampleFlags`] enum
+/// ExampleFlags {
+/// /// Optional docstring for [`ExampleFlags::Flag0`]
+/// 0 : Flag0,
+/// /// Optional docstring for [`ExampleFlags::Flag1`]
+/// 1 : Flag1,
+/// /// Optional docstring for [`ExampleFlags::Flag2`]
+/// 2 : Flag2,
+/// /// Optional docstring for [`ExampleFlags::Flag3`]
+/// 3 : Flag3,
+/// /// Optional docstring for [`ExampleFlags::Flag4`]
+/// 4 : Flag4,
+/// /// Optional docstring for [`ExampleFlags::Flag5`]
+/// 5 : Flag5,
+/// /// Optional docstring for [`ExampleFlags::Flag6`]
+/// 6 : Flag6,
+/// /// Optional docstring for [`ExampleFlags::Flag7`]
+/// 7 : Flag7,
+/// }
+/// }
+/// ```
+///
+/// You don't have to name *all* the fields if you don't need them...
+///
+/// You can use just a few from the front:
+/// ```rust
+/// use ubits::bitfield;
+///
+/// bitfield! {
+/// /// Optional docstring
+/// /// for [`ExampleField`] struct
+/// pub u8 ExampleField
+/// /// Optional docstring
+/// /// for [`ExampleFlags`] enum
+/// ExampleFlags {
+/// /// Optional docstring for [`ExampleFlags::Flag0`]
+/// 0 : Flag0,
+/// /// Optional docstring for [`ExampleFlags::Flag1`]
+/// 1 : Flag1,
+/// /// Optional docstring for [`ExampleFlags::Flag2`]
+/// 2 : Flag2,
+/// }
+/// }
+/// ```
+///
+/// ... or any valid indices:
+/// ```rust
+/// use ubits::bitfield;
+///
+/// bitfield! {
+/// /// Optional docstring
+/// /// for [`ExampleField`] struct
+/// pub u8 ExampleField
+/// /// Optional docstring
+/// /// for [`ExampleFlags`] enum
+/// ExampleFlags {
+/// /// Optional docstring for [`ExampleFlags::Flag0`]
+/// 0 : Flag0,
+/// /// Optional docstring for [`ExampleFlags::Flag1`]
+/// 3 : Flag1,
+/// /// Optional docstring for [`ExampleFlags::Flag2`]
+/// 6 : Flag2,
+/// }
+/// }
+/// ```
+/// ... or just omit the flags altogether and use indices only.:
+/// ```rust
+/// use ubits::bitfield;
+/// bitfield! {
+/// /// Optional docstring
+/// /// for [`ExampleField`] struct
+/// pub u8 ExampleField
+/// }
+/// ```
+/// __Note: if you omit flags, no flag enum will be generated
+/// and no methods for the bitfield struct that rely on flags will be generated.__
+///
+#[macro_export(local_inner_macros)]
+macro_rules! bitfield {
+
+ // U8
+ (
+ $(#[$doc:meta])*
+ $access:vis u8 $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( : ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( : ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
- __bitfield_unchecked!( $(#[$doc])* $access [u8] [8] [u8::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
+ )?
+ ) => {
+ __bitfield_unchecked!( $(#[$doc])* $access [u8] [8] [u8::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
};
- // U16
- (
- $(#[$doc:meta])*
- $access:vis u16 $name:ident
+ // U16
+ (
+ $(#[$doc:meta])*
+ $access:vis u16 $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
- __bitfield_unchecked!( $(#[$doc])* $access [u16] [16] [u16::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
+ )?
+ ) => {
+ __bitfield_unchecked!( $(#[$doc])* $access [u16] [16] [u16::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
};
- // U32
- (
- $(#[$doc:meta])*
- $access:vis u32 $name:ident
+ // U32
+ (
+ $(#[$doc:meta])*
+ $access:vis u32 $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
- __bitfield_unchecked!( $(#[$doc])* $access [u32] [32] [u32::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
+ )?
+ ) => {
+ __bitfield_unchecked!( $(#[$doc])* $access [u32] [32] [u32::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
};
- // U64
- (
- $(#[$doc:meta])*
- $access:vis u64 $name:ident
+ // U64
+ (
+ $(#[$doc:meta])*
+ $access:vis u64 $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
- __bitfield_unchecked!( $(#[$doc])* $access [u64] [64] [u64::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
+ )?
+ ) => {
+ __bitfield_unchecked!( $(#[$doc])* $access [u64] [64] [u64::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
};
- // U128
- (
- $(#[$doc:meta])*
- $access:vis u128 $name:ident
+ // U128
+ (
+ $(#[$doc:meta])*
+ $access:vis u128 $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
- __bitfield_unchecked!( $(#[$doc])* $access [u128] [128] [u128::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
+ )?
+ ) => {
+ __bitfield_unchecked!( $(#[$doc])* $access [u128] [128] [u128::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
};
- // USIZE
- (
- $(#[$doc:meta])*
- $access:vis usize $name:ident
+ // USIZE
+ (
+ $(#[$doc:meta])*
+ $access:vis usize $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
- __bitfield_unchecked!( $(#[$doc])* $access [usize] [usize::BITS as usize] [usize::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
+ )?
+ ) => {
+ __bitfield_unchecked!( $(#[$doc])* $access [usize] [usize::BITS as usize] [usize::MAX] $name $($(#[$flag_doc])* $flag { $( $(#[$member_doc])* $idx : $field $(($named_getter))?, )* } )?);
};
}
-/// Not to be used directly.
-///
-/// Generates a bitfield struct and flag enum
-/// but does no type checking.
-/// Passing types that aren't unsigned integer types is undefined behaviour.
-///
-/// Use the [`bitfield`] macro instead as it enforces a closed set of types.
-#[doc(hidden)]
-#[macro_export(local_inner_macros)]
-macro_rules! __bitfield_unchecked {
+/// Not to be used directly.
+///
+/// Generates a bitfield struct and flag enum
+/// but does no type checking.
+/// Passing types that aren't unsigned integer types is undefined behaviour.
+///
+/// Use the [`bitfield`] macro instead as it enforces a closed set of types.
+#[doc(hidden)]
+#[macro_export(local_inner_macros)]
+macro_rules! __bitfield_unchecked {
(
- $(#[$field_doc:meta])*
- $access:vis [$type:ty] [$($bits:tt)*] [$max:path] $name:ident
+ $(#[$field_doc:meta])*
+ $access:vis [$type:ty] [$($bits:tt)*] [$max:path] $name:ident
$(
- $(#[$flag_doc:meta])*
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
+ )?
+ ) => {
$(
- __def_flag_enum! {
- $(#[$flag_doc])*
- $access $name
- $flag {
+ __def_flag_enum! {
+ $(#[$flag_doc])*
+ $access $name
+ $flag {
$(
- $(#[$member_doc])*
- $idx : $field $(($named_getter))?,
- )*
+ $(#[$member_doc])*
+ $idx : $field $(($named_getter))?,
+ )*
}
}
- )?
+ )?
- __def_field_struct! {
- $(#[$field_doc])*
- $access [$type] [$($bits)*] [$max] $name
- $(
- $flag {
+ __def_field_struct! {
+ $(#[$field_doc])*
+ $access [$type] [$($bits)*] [$max] $name
+ $(
+ $flag {
$(
- $(#[$member_doc])*
- $idx : $field $(($named_getter))?,
- )*
+ $(#[$member_doc])*
+ $idx : $field $(($named_getter))?,
+ )*
}
- )?
- }
+ )?
+ }
};
}
-// -------------------------------------------------------------------------------------------------
-// Type Definitions
+// -------------------------------------------------------------------------------------------------
+// Type Definitions
-/// Defines a field struct with its members and implementations
-#[doc(hidden)]
-#[macro_export(local_inner_macros)]
-macro_rules! __def_field_struct {
+/// Defines a field struct with its members and implementations
+#[doc(hidden)]
+#[macro_export(local_inner_macros)]
+macro_rules! __def_field_struct {
(
- $(#[$field_doc:meta])*
- $access:vis [$type:ty] [$($bits:tt)*] [$max:path] $name:ident
+ $(#[$field_doc:meta])*
+ $access:vis [$type:ty] [$($bits:tt)*] [$max:path] $name:ident
$(
- $flag:ident {
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
- )?
- ) => {
+ )?
+ ) => {
- // Struct: $name
- $(#[$field_doc])*
- #[derive(Copy, Clone, PartialEq, PartialOrd)]
- $access struct $name($type);
+ // Struct: $name
+ $(#[$field_doc])*
+ #[derive(Copy, Clone, PartialEq, PartialOrd)]
+ $access struct $name($type);
$(
- impl $name {
+ impl $name {
$(
$(
- __paste! {
- fn [< is_ $named_getter >](&self) -> bool {
- self.get($flag::$field)
+ __paste! {
+ pub fn [< is_ $named_getter >](&self) -> bool {
+ self.get($flag::$field)
}
}
- __paste! {
- fn [< set_ $named_getter >](&mut self) {
- self.set($flag::$field);
+ __paste! {
+ pub fn [< set_ $named_getter >](&mut self) {
+ self.set($flag::$field);
}
}
- __paste! {
- fn [< clear_ $named_getter >](&mut self) {
- self.clear($flag::$field);
+ __paste! {
+ pub fn [< clear_ $named_getter >](&mut self) {
+ self.clear($flag::$field);
}
}
- __paste! {
- fn [< toggle_ $named_getter >](&mut self) {
- self.toggle($flag::$field);
+ __paste! {
+ pub fn [< toggle_ $named_getter >](&mut self) {
+ self.toggle($flag::$field);
}
}
- )?
- )*
+ )?
+ )*
}
- )?
+ )?
- // Constants
- __impl_field_constants! {
- $name { type: $type, max: $max, bits: [$($bits)*] }
+ // Constants
+ __impl_field_constants! {
+ $name { type: $type, max: $max, bits: [$($bits)*] }
}
- // Constructors
- __impl_field_ctors! {
- $name : $type
- }
+ // Constructors
+ __impl_field_ctors! {
+ $name : $type
+ }
- // State
- __impl_field_state! {
- $name : $type
- }
+ // State
+ __impl_field_state! {
+ $name : $type
+ }
- // Indexers
- __impl_field_index_accessors! {
- $name
- }
+ // Indexers
+ __impl_field_index_accessors! {
+ $name
+ }
$(
- // Flags
- __impl_field_flag_accessors! {
- $name $flag $type
- }
- )?
+ // Flags
+ __impl_field_flag_accessors! {
+ $name $flag $type
+ }
+ )?
- // Combinators
- __impl_field_flag_combinators! {
- $name
- }
+ // Combinators
+ __impl_field_flag_combinators! {
+ $name
+ }
- // Converters
- __impl_field_flag_converters! {
- $name
- }
+ // Converters
+ __impl_field_flag_converters! {
+ $name
+ }
- // Name: $name
- __impl_default! {
- $name => { $name(0) }
+ // Name: $name
+ __impl_default! {
+ $name => { $name(0) }
}
- // From: $type -> $name
- __impl_from! {
- /// Returns a field instance from value of its underlying type.
- $type as $name (value) => {
- $name(value)
+ // From: $type -> $name
+ __impl_from! {
+ /// Returns a field instance from value of its underlying type.
+ $type as $name (value) => {
+ $name(value)
}
}
$(
- // From: $flag -> $name
- __impl_from! {
- /// Returns a field instance from a flag.
- $flag as $name (value) => {
- Self(0 | (1 << (value as $type)) )
+ // From: $flag -> $name
+ __impl_from! {
+ /// Returns a field instance from a flag.
+ $flag as $name (value) => {
+ Self(0 | (1 << (value as $type)) )
}
}
- )?
+ )?
- // Bitwise: $name + $name
- __impl_bitwise_operators! {
- [Self] for $name : (self rhs -> Self)
- BitAnd => { Self(self.0 & rhs.0) }
- BitOr => { Self(self.0 | rhs.0) }
- BitXor => { Self(self.0 ^ rhs.0) }
- BitAndAssign => { self.0 &= rhs.0; }
- BitOrAssign => { self.0 |= rhs.0; }
- BitXorAssign => { self.0 ^= rhs.0; }
+ // Bitwise: $name + $name
+ __impl_bitwise_operators! {
+ [Self] for $name : (self rhs -> Self)
+ BitAnd => { Self(self.0 & rhs.0) }
+ BitOr => { Self(self.0 | rhs.0) }
+ BitXor => { Self(self.0 ^ rhs.0) }
+ BitAndAssign => { self.0 &= rhs.0; }
+ BitOrAssign => { self.0 |= rhs.0; }
+ BitXorAssign => { self.0 ^= rhs.0; }
}
$(
- // Bitwise: $name + $flag
- __impl_bitwise_operators! {
- [$flag] for $name : (self rhs -> $name)
- BitAnd => { $name(self.0 & !(1 << (rhs as $type))) }
- BitOr => { $name(self.0 | (1 << (rhs as $type))) }
- BitXor => { $name(self.0 ^ (1 << (rhs as $type))) }
- BitAndAssign => { self.clear(rhs); }
- BitOrAssign => { self.set(rhs); }
- BitXorAssign => { self.toggle(rhs); }
+ // Bitwise: $name + $flag
+ __impl_bitwise_operators! {
+ [$flag] for $name : (self rhs -> $name)
+ BitAnd => { $name(self.0 & !(1 << (rhs as $type))) }
+ BitOr => { $name(self.0 | (1 << (rhs as $type))) }
+ BitXor => { $name(self.0 ^ (1 << (rhs as $type))) }
+ BitAndAssign => { self.clear(rhs); }
+ BitOrAssign => { self.set(rhs); }
+ BitXorAssign => { self.toggle(rhs); }
}
- // Bitwise: &$name + $flag
- __impl_bitwise_operators! {
- [$flag] for & $name : (self rhs -> $name)
- BitAnd => { $name(self.0 & !(1 << (rhs as $type))) }
- BitOr => { $name(self.0 | (1 << (rhs as $type))) }
- BitXor => { $name(self.0 ^ (1 << (rhs as $type))) }
+ // Bitwise: &$name + $flag
+ __impl_bitwise_operators! {
+ [$flag] for & $name : (self rhs -> $name)
+ BitAnd => { $name(self.0 & !(1 << (rhs as $type))) }
+ BitOr => { $name(self.0 | (1 << (rhs as $type))) }
+ BitXor => { $name(self.0 ^ (1 << (rhs as $type))) }
}
- // Bitwise: $mut $name + $flag
- __impl_bitwise_operators! {
- [$flag] for &mut $name : (self rhs -> $name)
- BitAnd => { $name(self.0 & !(1 << (rhs as $type))) }
- BitOr => { $name(self.0 | (1 << (rhs as $type))) }
- BitXor => { $name(self.0 ^ (1 << (rhs as $type))) }
+ // Bitwise: $mut $name + $flag
+ __impl_bitwise_operators! {
+ [$flag] for &mut $name : (self rhs -> $name)
+ BitAnd => { $name(self.0 & !(1 << (rhs as $type))) }
+ BitOr => { $name(self.0 | (1 << (rhs as $type))) }
+ BitXor => { $name(self.0 ^ (1 << (rhs as $type))) }
}
- )?
+ )?
- // Bitwise: Debug & Binary
- __impl_formatters! {
- $name (self f) {
- Debug => { core::write!(f, "{}({})", core::stringify!($name), self.as_binary()) }
- Binary => { core::write!(f, "{}", self.as_binary()) }
+ // Bitwise: Debug & Binary
+ __impl_formatters! {
+ $name (self f) {
+ Debug => { core::write!(f, "{}({})", core::stringify!($name), self.as_binary()) }
+ Binary => { core::write!(f, "{}", self.as_binary()) }
}
}
};
}
-/// Defines a flag enum with its members and implementations
-#[doc(hidden)]
-#[macro_export(local_inner_macros)]
-macro_rules! __def_flag_enum {
+/// Defines a flag enum with its members and implementations
+#[doc(hidden)]
+#[macro_export(local_inner_macros)]
+macro_rules! __def_flag_enum {
(
- $(#[$flag_doc:meta])*
- $access:vis $name:ident
- $flag:ident {
+ $(#[$flag_doc:meta])*
+ $access:vis $name:ident
+ $flag:ident {
$(
- $(#[$member_doc:meta])*
- $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
- )*
+ $(#[$member_doc:meta])*
+ $idx:literal : $field:ident $( ( $named_getter:ident ) )?,
+ )*
}
) => {
- // Enum: $flag
- $(#[$flag_doc])*
- #[derive(Debug, Copy, Clone, PartialEq, PartialOrd)]
- #[repr(u8)]
- $access enum $flag {
- $( $(#[$member_doc])* $field = $idx ),*
- }
-
- // Bitwise: $flag + $flag
- __impl_bitwise_operators! {
- [Self] for $flag : (self rhs -> $name)
- BitAnd => { $name(0).clear(self) & rhs }
- BitOr => { $name(0).set(self) | rhs }
- BitXor => { $name(0).toggle(self) ^ rhs }
- }
-
- // Bitwise: u8 -> $flag
- __impl_from! {
- /// Converts a [`u8`] to a flag
- ///
- /// # Errors
- ///
- /// Panics if the supplied [`u8`] is out of range for fields base type.
- /// eg: for a 16-bit field (using [`u16`]),
- /// providing an index of `20` will cause a panic.
- u8 as $flag (value) => {
- $crate::__transmute_one::<$flag>(&[value])
- .expect(std::format!(
+ // Enum: $flag
+ $(#[$flag_doc])*
+ #[derive(Debug, Copy, Clone, PartialEq, PartialOrd)]
+ #[repr(u8)]
+ $access enum $flag {
+ $( $(#[$member_doc])* $field = $idx ),*
+ }
+
+ // Bitwise: $flag + $flag
+ __impl_bitwise_operators! {
+ [Self] for $flag : (self rhs -> $name)
+ BitAnd => { $name(0).clear(self) & rhs }
+ BitOr => { $name(0).set(self) | rhs }
+ BitXor => { $name(0).toggle(self) ^ rhs }
+ }
+
+ // Bitwise: u8 -> $flag
+ __impl_from! {
+ /// Converts a [`u8`] to a flag
+ ///
+ /// # Errors
+ ///
+ /// Panics if the supplied [`u8`] is out of range for fields base type.
+ /// eg: for a 16-bit field (using [`u16`]),
+ /// providing an index of `20` will cause a panic.
+ u8 as $flag (value) => {
+ $crate::__transmute_one::<$flag>(&[value])
+ .expect(std::format!(
"failed to transmute {} to {}. {} is not a valid index in {}.",
- value,
- core::stringify!($flag),
- value,
- core::stringify!($flag)
- ).as_str())
+ value,
+ core::stringify!($flag),
+ value,
+ core::stringify!($flag)
+ ).as_str())
}
}
- // Bitwise: $flag -> u8
- __impl_from! {
- /// Returns a flag as its corresponding [`u8`] value.
- $flag as u8 (value) => {
- value as u8
+ // Bitwise: $flag -> u8
+ __impl_from! {
+ /// Returns a flag as its corresponding [`u8`] value.
+ $flag as u8 (value) => {
+ value as u8
}
}
- unsafe impl $crate::__TriviallyTransmutable for $flag {}
+ unsafe impl $crate::__TriviallyTransmutable for $flag {}
};
}
-// -------------------------------------------------------------------------------------------------
-// Field Implementations
+// -------------------------------------------------------------------------------------------------
+// Field Implementations
-/// Generates constants for `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_constants {
- ($name:ident { type: $type:ty, max: $max:path, bits: [$($bits:tt)*] }) => {
- $crate::__doc_comment! {
+/// Generates constants for `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_constants {
+ ($name:ident { type: $type:ty, max: $max:path, bits: [$($bits:tt)*] }) => {
+ $crate::__doc_comment! {
core::concat!(
- "Constant values describing [`", core::stringify!($name), "`]."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Constant values describing [`", core::stringify!($name), "`]."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Number of bits in an instance of [`", core::stringify!($name), "`]."
- ),
- pub const BITS: usize = $($bits)*;
+ "Number of bits in an instance of [`", core::stringify!($name), "`]."
+ ),
+ pub const BITS: usize = $($bits)*;
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Number of bytes used by an instance of [`", core::stringify!($name), "`]."
- ),
- pub const BYTES: usize = $($bits)* / 8;
+ "Number of bytes used by an instance of [`", core::stringify!($name), "`]."
+ ),
+ pub const BYTES: usize = $($bits)* / 8;
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Maximum valid integer for [`", core::stringify!($name), "`]."
- ),
- pub const MAX: $type = $max;
+ "Maximum valid integer for [`", core::stringify!($name), "`]."
+ ),
+ pub const MAX: $type = $max;
}
}
}
};
}
-/// Generates constructors for `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_ctors {
- ( $name:ident : $type:ty ) => {
- $crate::__doc_comment! {
+/// Generates constructors for `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_ctors {
+ ( $name:ident : $type:ty ) => {
+ $crate::__doc_comment! {
core::concat!(
- "Constructors for creating instances of [`", core::stringify!($name), "`]."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Constructors for creating instances of [`", core::stringify!($name), "`]."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Create a new instance of [`", core::stringify!($name), "`] ",
- "from a [`", core::stringify!($type), "`] value."
- ),
- pub fn new(value: $type) -> Self {
- Self(value)
+ "Create a new instance of [`", core::stringify!($name), "`] ",
+ "from a [`", core::stringify!($type), "`] value."
+ ),
+ pub fn new(value: $type) -> Self {
+ Self(value)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Create a new instance of [`", core::stringify!($name), "`] ",
- "from `0`."
- ),
- pub fn zeros() -> Self {
+ "Create a new instance of [`", core::stringify!($name), "`] ",
+ "from `0`."
+ ),
+ pub fn zeros() -> Self {
Self(0)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Create a new instance of [`", core::stringify!($name), "`] ",
- "from the maximum possible integer value."
- ),
- pub fn ones() -> Self {
- Self(Self::MAX)
+ "Create a new instance of [`", core::stringify!($name), "`] ",
+ "from the maximum possible integer value."
+ ),
+ pub fn ones() -> Self {
+ Self(Self::MAX)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Create a new instance of [`", core::stringify!($name), "`] ",
- "from a binary string."
- ),
- pub fn from_binary_str(value: &str) -> Self {
- Self(<$type>::from_str_radix(value, 2).unwrap())
+ "Create a new instance of [`", core::stringify!($name), "`] ",
+ "from a binary string."
+ ),
+ pub fn from_binary_str(value: &str) -> Self {
+ Self(<$type>::from_str_radix(value, 2).unwrap())
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Create a new instance of [`", core::stringify!($name), "`] ",
- "from a binary string."
- ),
- pub fn from_binary_string(value: String) -> Self {
- Self(<$type>::from_str_radix(value.as_str(), 2).unwrap())
+ "Create a new instance of [`", core::stringify!($name), "`] ",
+ "from a binary string."
+ ),
+ pub fn from_binary_string(value: String) -> Self {
+ Self(<$type>::from_str_radix(value.as_str(), 2).unwrap())
}
}
}
@@ -5050,31 +5045,31 @@
};
}
-/// Generates getters for state fields in `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_state {
- ($name:ident : $type:ty) => {
- $crate::__doc_comment! {
+/// Generates getters for state fields in `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_state {
+ ($name:ident : $type:ty) => {
+ $crate::__doc_comment! {
core::concat!(
- "Current state of this bitfield."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Current state of this bitfield."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Returns the current field value as a [`", core::stringify!($type), "`]"
- ),
- pub fn as_integer(&self) -> $type {
- self.0
- }
+ "Returns the current field value as a [`", core::stringify!($type), "`]"
+ ),
+ pub fn as_integer(&self) -> $type {
+ self.0
+ }
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Returns the current field value as a binary formatted string."
- ),
- pub fn as_binary(&self) -> String {
- std::format!("{:0width$b}", self.0, width = Self::BITS)
+ "Returns the current field value as a binary formatted string."
+ ),
+ pub fn as_binary(&self) -> String {
+ std::format!("{:0width$b}", self.0, width = Self::BITS)
}
}
}
@@ -5082,49 +5077,49 @@
};
}
-/// Generates getters by index for bit fields in `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_index_accessors {
- ($name:ident) => {
- $crate::__doc_comment! {
+/// Generates getters by index for bit fields in `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_index_accessors {
+ ($name:ident) => {
+ $crate::__doc_comment! {
core::concat!(
- "Field accessors by index for [`", core::stringify!($name), "`]."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Field accessors by index for [`", core::stringify!($name), "`]."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Returns the value of the bit at the supplied index as a boolean."
- ),
- pub fn get_index(&self, index: u8) -> bool {
- ((self.0 >> index) & 1) == 1
- }
+ "Returns the value of the bit at the supplied index as a boolean."
+ ),
+ pub fn get_index(&self, index: u8) -> bool {
+ ((self.0 >> index) & 1) == 1
+ }
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Sets the value of the bit at the supplied index to `1`."
- ),
- pub fn set_index(&mut self, index: u8) {
- self.0 |= (1 << index);
+ "Sets the value of the bit at the supplied index to `1`."
+ ),
+ pub fn set_index(&mut self, index: u8) {
+ self.0 |= (1 << index);
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Sets the value of the bit at the supplied index to `0`."
- ),
- pub fn clear_index(&mut self, index: u8) {
- self.0 &= !(1 << index);
+ "Sets the value of the bit at the supplied index to `0`."
+ ),
+ pub fn clear_index(&mut self, index: u8) {
+ self.0 &= !(1 << index);
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Flips the value of the bit at the supplied index."
- ),
- pub fn toggle_index(&mut self, index: u8) {
- self.0 ^= (1 << index);
+ "Flips the value of the bit at the supplied index."
+ ),
+ pub fn toggle_index(&mut self, index: u8) {
+ self.0 ^= (1 << index);
}
}
}
@@ -5132,99 +5127,99 @@
};
}
-/// Generates getters by flag for bit fields in `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_flag_accessors {
- ($name:ident $flag:ident $type:ty) => {
- $crate::__doc_comment! {
+/// Generates getters by flag for bit fields in `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_flag_accessors {
+ ($name:ident $flag:ident $type:ty) => {
+ $crate::__doc_comment! {
core::concat!(
- "Named field accessors by [`", core::stringify!($flag), "`] for [`", core::stringify!($name), "`]."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Named field accessors by [`", core::stringify!($flag), "`] for [`", core::stringify!($name), "`]."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Returns the value of the bit at the supplied flag as a boolean."
- ),
- pub fn get(&self, flag: $flag) -> bool {
- ((self.0 >> (flag as $type)) & 1) == 1
- }
+ "Returns the value of the bit at the supplied flag as a boolean."
+ ),
+ pub fn get(&self, flag: $flag) -> bool {
+ ((self.0 >> (flag as $type)) & 1) == 1
+ }
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Sets the value of the bit at the supplied flag to `1`."
- ),
- pub fn set(&mut self, flag: $flag) -> &mut Self {
- self.0 |= (1 << (flag as $type));
- self
- }
+ "Sets the value of the bit at the supplied flag to `1`."
+ ),
+ pub fn set(&mut self, flag: $flag) -> &mut Self {
+ self.0 |= (1 << (flag as $type));
+ self
+ }
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Sets the value of the bit at the supplied flag to `0`."
- ),
- pub fn clear(&mut self, flag: $flag) -> &mut Self {
- self.0 &= !(1 << (flag as $type));
- self
- }
+ "Sets the value of the bit at the supplied flag to `0`."
+ ),
+ pub fn clear(&mut self, flag: $flag) -> &mut Self {
+ self.0 &= !(1 << (flag as $type));
+ self
+ }
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Flips the value of the bit at the supplied flag."
- ),
- pub fn toggle(&mut self, flag: $flag) -> &mut Self {
- self.0 ^= (1 << (flag as $type));
- self
- }
+ "Flips the value of the bit at the supplied flag."
+ ),
+ pub fn toggle(&mut self, flag: $flag) -> &mut Self {
+ self.0 ^= (1 << (flag as $type));
+ self
+ }
}
}
}
};
}
-/// Generates combinator methods for `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_flag_combinators {
- ($name:ident) => {
- $crate::__doc_comment! {
+/// Generates combinator methods for `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_flag_combinators {
+ ($name:ident) => {
+ $crate::__doc_comment! {
core::concat!(
- "Combinators for [`", core::stringify!($name), "`]."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Combinators for [`", core::stringify!($name), "`]."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Returns a new [`", core::stringify!($name), "`]",
+ "Returns a new [`", core::stringify!($name), "`]",
"with ones for flags that do not match. ",
- "Does not consume `self`."
- ),
- pub fn diff(&self, other: Self) -> Self {
- Self(self.0 ^ other.0)
+ "Does not consume `self`."
+ ),
+ pub fn diff(&self, other: Self) -> Self {
+ Self(self.0 ^ other.0)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Returns a new [`", core::stringify!($name), "`]",
+ "Returns a new [`", core::stringify!($name), "`]",
"with ones for flags that were set on either input. ",
- "Does not consume `self`."
- ),
- pub fn combine(&self, other: Self) -> Self {
- Self(self.0 | other.0)
+ "Does not consume `self`."
+ ),
+ pub fn combine(&self, other: Self) -> Self {
+ Self(self.0 | other.0)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Returns a new [`", core::stringify!($name), "`]",
+ "Returns a new [`", core::stringify!($name), "`]",
"with ones for flags that were set on both inputs. ",
- "Does not consume `self`."
- ),
- pub fn intersect(&self, other: Self) -> Self {
- Self(self.0 & other.0)
+ "Does not consume `self`."
+ ),
+ pub fn intersect(&self, other: Self) -> Self {
+ Self(self.0 & other.0)
}
}
}
@@ -5232,46 +5227,46 @@
};
}
-/// Generates conversion methods for `$name`
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_field_flag_converters {
- ($name:ident) => {
- $crate::__doc_comment! {
+/// Generates conversion methods for `$name`
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_field_flag_converters {
+ ($name:ident) => {
+ $crate::__doc_comment! {
core::concat!(
- "Conversion methods."
- ),
- impl $name {
- $crate::__doc_comment! {
+ "Conversion methods."
+ ),
+ impl $name {
+ $crate::__doc_comment! {
core::concat!(
- "Returns a new [`", core::stringify!($name), "`]",
+ "Returns a new [`", core::stringify!($name), "`]",
"with ones for flags that do not match. ",
- "Consumes `self`."
- ),
- pub fn into_diff(self, other: Self) -> Self {
- Self(self.0 ^ other.0)
+ "Consumes `self`."
+ ),
+ pub fn into_diff(self, other: Self) -> Self {
+ Self(self.0 ^ other.0)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Returns a new [`", core::stringify!($name), "`]",
+ "Returns a new [`", core::stringify!($name), "`]",
"with ones for flags that were set on either input. ",
- "Consumes `self`."
- ),
- pub fn into_combined(self, other: Self) -> Self {
- Self(self.0 | other.0)
+ "Consumes `self`."
+ ),
+ pub fn into_combined(self, other: Self) -> Self {
+ Self(self.0 | other.0)
}
}
- $crate::__doc_comment! {
+ $crate::__doc_comment! {
core::concat!(
- "Returns a new [`", core::stringify!($name), "`]",
+ "Returns a new [`", core::stringify!($name), "`]",
"with ones for flags that were set on both inputs. ",
- "Consumes `self`."
- ),
- pub fn into_intersection(self, other: Self) -> Self {
- Self(self.0 & other.0)
+ "Consumes `self`."
+ ),
+ pub fn into_intersection(self, other: Self) -> Self {
+ Self(self.0 & other.0)
}
}
}
@@ -5279,2402 +5274,2400 @@
};
}
-// -------------------------------------------------------------------------------------------------
-// Trait Implementations
-
-// Operators
-
-/// Generates a set of bitwise operators
-/// for a set of parameters
-#[doc(hidden)]
-#[macro_export(local_inner_macros)]
-macro_rules! __impl_bitwise_operators {
-
- // Owned
- (
- [$flag:ty] for $dest:ident : ($self:ident $other:ident -> $output:ident)
- $( BitAnd => $bitand:block )?
- $( BitOr => $bitor:block )?
- $( BitXor => $bitxor:block )?
- $( BitAndAssign => $bitand_assign:block )?
- $( BitOrAssign => $bitor_assign:block )?
- $( BitXorAssign => $bitxor_assign:block )?
- ) => {
- $( __impl_operator! {BitAnd [$flag] bitand for $dest ($self $other -> $output) => $bitand} )?
- $( __impl_operator! {BitOr [$flag] bitor for $dest ($self $other -> $output) => $bitor} )?
- $( __impl_operator! {BitXor [$flag] bitxor for $dest ($self $other -> $output) => $bitxor} )?
-
- $( __impl_assign_operator! {BitAndAssign [$flag] bitand_assign for $dest ($self $other) => $bitand_assign} )?
- $( __impl_assign_operator! {BitOrAssign [$flag] bitor_assign for $dest ($self $other) => $bitor_assign} )?
- $( __impl_assign_operator! {BitXorAssign [$flag] bitxor_assign for $dest ($self $other) => $bitxor_assign} )?
- };
-
- // Reference
- (
- [$flag:ty] for & $dest:ident : ($self:ident $other:ident -> $output:ident)
- $( BitAnd => $bitand:block )?
- $( BitOr => $bitor:block )?
- $( BitXor => $bitxor:block )?
- ) => {
- $( __impl_operator! {BitAnd [$flag] bitand for & $dest ($self $other -> $output) => $bitand} )?
- $( __impl_operator! {BitOr [$flag] bitor for & $dest ($self $other -> $output) => $bitor} )?
- $( __impl_operator! {BitXor [$flag] bitxor for & $dest ($self $other -> $output) => $bitxor} )?
- };
-
- // Mutable Reference
- (
- [$flag:ty] for &mut $dest:ident : ($self:ident $other:ident -> $output:ident)
- $( BitAnd => $bitand:block )?
- $( BitOr => $bitor:block )?
- $( BitXor => $bitxor:block )?
- ) => {
- $( __impl_operator! {BitAnd [$flag] bitand for &mut $dest ($self $other -> $output) => $bitand} )?
- $( __impl_operator! {BitOr [$flag] bitor for &mut $dest ($self $other -> $output) => $bitor} )?
- $( __impl_operator! {BitXor [$flag] bitxor for &mut $dest ($self $other -> $output) => $bitxor} )?
- };
+// -------------------------------------------------------------------------------------------------
+// Trait Implementations
+
+// Operators
+
+/// Generates a set of bitwise operators
+/// for a set of parameters
+#[doc(hidden)]
+#[macro_export(local_inner_macros)]
+macro_rules! __impl_bitwise_operators {
+
+ // Owned
+ (
+ [$flag:ty] for $dest:ident : ($self:ident $other:ident -> $output:ident)
+ $( BitAnd => $bitand:block )?
+ $( BitOr => $bitor:block )?
+ $( BitXor => $bitxor:block )?
+ $( BitAndAssign => $bitand_assign:block )?
+ $( BitOrAssign => $bitor_assign:block )?
+ $( BitXorAssign => $bitxor_assign:block )?
+ ) => {
+ $( __impl_operator! {BitAnd [$flag] bitand for $dest ($self $other -> $output) => $bitand} )?
+ $( __impl_operator! {BitOr [$flag] bitor for $dest ($self $other -> $output) => $bitor} )?
+ $( __impl_operator! {BitXor [$flag] bitxor for $dest ($self $other -> $output) => $bitxor} )?
+
+ $( __impl_assign_operator! {BitAndAssign [$flag] bitand_assign for $dest ($self $other) => $bitand_assign} )?
+ $( __impl_assign_operator! {BitOrAssign [$flag] bitor_assign for $dest ($self $other) => $bitor_assign} )?
+ $( __impl_assign_operator! {BitXorAssign [$flag] bitxor_assign for $dest ($self $other) => $bitxor_assign} )?
+ };
+
+ // Reference
+ (
+ [$flag:ty] for & $dest:ident : ($self:ident $other:ident -> $output:ident)
+ $( BitAnd => $bitand:block )?
+ $( BitOr => $bitor:block )?
+ $( BitXor => $bitxor:block )?
+ ) => {
+ $( __impl_operator! {BitAnd [$flag] bitand for & $dest ($self $other -> $output) => $bitand} )?
+ $( __impl_operator! {BitOr [$flag] bitor for & $dest ($self $other -> $output) => $bitor} )?
+ $( __impl_operator! {BitXor [$flag] bitxor for & $dest ($self $other -> $output) => $bitxor} )?
+ };
+
+ // Mutable Reference
+ (
+ [$flag:ty] for &mut $dest:ident : ($self:ident $other:ident -> $output:ident)
+ $( BitAnd => $bitand:block )?
+ $( BitOr => $bitor:block )?
+ $( BitXor => $bitxor:block )?
+ ) => {
+ $( __impl_operator! {BitAnd [$flag] bitand for &mut $dest ($self $other -> $output) => $bitand} )?
+ $( __impl_operator! {BitOr [$flag] bitor for &mut $dest ($self $other -> $output) => $bitor} )?
+ $( __impl_operator! {BitXor [$flag] bitxor for &mut $dest ($self $other -> $output) => $bitxor} )?
+ };
}
-/// Generates a generic operator
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_operator {
-
- // Owned
- ( $op_type:ident [$rhs:ty] $op_lower:ident for $dest:ident ($self:ident $other:ident -> $output:ident) => $block:block ) => {
- impl std::ops::$op_type<$rhs> for $dest {
- type Output = $output;
- fn $op_lower($self, $other: $rhs) -> Self::Output $block
- }
+/// Generates a generic operator
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_operator {
+
+ // Owned
+ ( $op_type:ident [$rhs:ty] $op_lower:ident for $dest:ident ($self:ident $other:ident -> $output:ident) => $block:block ) => {
+ impl std::ops::$op_type<$rhs> for $dest {
+ type Output = $output;
+ fn $op_lower($self, $other: $rhs) -> Self::Output $block
+ }
};
- // Reference
- ( $op_type:ident [$rhs:ty] $op_lower:ident for & $dest:ident ($self:ident $other:ident -> $output:ident) => $block:block ) => {
- impl std::ops::$op_type<$rhs> for &$dest {
- type Output = $output;
- fn $op_lower($self, $other: $rhs) -> Self::Output $block
- }
+ // Reference
+ ( $op_type:ident [$rhs:ty] $op_lower:ident for & $dest:ident ($self:ident $other:ident -> $output:ident) => $block:block ) => {
+ impl std::ops::$op_type<$rhs> for &$dest {
+ type Output = $output;
+ fn $op_lower($self, $other: $rhs) -> Self::Output $block
+ }
};
- // Mutable Reference
- ( $op_type:ident [$rhs:ty] $op_lower:ident for &mut $dest:ident ($self:ident $other:ident -> $output:ident) => $block:block ) => {
- impl std::ops::$op_type<$rhs> for &mut $dest {
- type Output = $output;
- fn $op_lower($self, $other: $rhs) -> Self::Output $block
- }
+ // Mutable Reference
+ ( $op_type:ident [$rhs:ty] $op_lower:ident for &mut $dest:ident ($self:ident $other:ident -> $output:ident) => $block:block ) => {
+ impl std::ops::$op_type<$rhs> for &mut $dest {
+ type Output = $output;
+ fn $op_lower($self, $other: $rhs) -> Self::Output $block
+ }
};
}
-/// Generates a generic assign operator
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_assign_operator {
- ( $op_type:ident [$rhs:ty] $op_lower:ident for $dest:ident ($self:ident $other:ident) => $block:block ) => {
- impl std::ops::$op_type<$rhs> for $dest {
- fn $op_lower(&mut $self, $other: $rhs) $block
- }
+/// Generates a generic assign operator
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_assign_operator {
+ ( $op_type:ident [$rhs:ty] $op_lower:ident for $dest:ident ($self:ident $other:ident) => $block:block ) => {
+ impl std::ops::$op_type<$rhs> for $dest {
+ fn $op_lower(&mut $self, $other: $rhs) $block
+ }
};
}
-// Defaults
+// Defaults
-/// Generates a [`Default`] implementation.
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_default {
- ($name:ident => $block:block) => {
- impl Default for $name {
- fn default() -> Self $block
- }
+/// Generates a [`Default`] implementation.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_default {
+ ($name:ident => $block:block) => {
+ impl Default for $name {
+ fn default() -> Self $block
+ }
};
}
-// Converters
-
-/// Generates a [`From`] implementation.
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_from {
- ($(#[$doc:meta])* $from:ty as $to:ident ($arg:ident) => $block:block) => {
- $(#[$doc])*
- impl From<$from> for $to {
- fn from($arg: $from) -> $to $block
- }
+// Converters
+
+/// Generates a [`From`] implementation.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_from {
+ ($(#[$doc:meta])* $from:ty as $to:ident ($arg:ident) => $block:block) => {
+ $(#[$doc])*
+ impl From<$from> for $to {
+ fn from($arg: $from) -> $to $block
+ }
};
}
-// Formatters
+// Formatters
-/// Generates formatter implementations
-/// from a set of parameters.
-#[doc(hidden)]
-#[macro_export(local_inner_macros)]
-macro_rules! __impl_formatters {
- ($name:ident ($self:ident $f:ident) { $( $formatter:ident => $block:block )+ } ) => {
- $( __impl_formatter!($formatter for $name ($self $f) => $block); )+
+/// Generates formatter implementations
+/// from a set of parameters.
+#[doc(hidden)]
+#[macro_export(local_inner_macros)]
+macro_rules! __impl_formatters {
+ ($name:ident ($self:ident $f:ident) { $( $formatter:ident => $block:block )+ } ) => {
+ $( __impl_formatter!($formatter for $name ($self $f) => $block); )+
};
}
-/// Generates a generic formatter implementation.
-#[doc(hidden)]
-#[macro_export]
-macro_rules! __impl_formatter {
- ($formatter:ident for $name:ident ($self:ident $f:ident) => $block:block) => {
- impl std::fmt::$formatter for $name {
- fn fmt(&$self, $f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result $block
- }
+/// Generates a generic formatter implementation.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __impl_formatter {
+ ($formatter:ident for $name:ident ($self:ident $f:ident) => $block:block) => {
+ impl std::fmt::$formatter for $name {
+ fn fmt(&$self, $f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result $block
+ }
};
}
-// -------------------------------------------------------------------------------------------------
-// Example
-
-#[allow(dead_code)]
-#[allow(unused_variables)]
-#[cfg(doc)]
-pub mod examples {
- //! Examples of generated output using different configurations.
- //!
- //! __This module is only compiled with documentation builds
- //! and will not be available for import.__
- //!
- //! use the [`bitfield`] macro to generate a field struct and flag enum.
- //!
-
- #[allow(dead_code)]
- #[allow(unused_variables)]
- #[cfg(doc)]
- pub mod full_example {
- //! Example of generated output, using both a bit field and a flag enum.
- //!
- //! __This module is only compiled with documentation builds
- //! and will not be available for import.__
- //!
- //! use the [`bitfield`] macro to generate a field struct and flag enum.
- //!
- use super::*;
-
- bitfield! {
- /// Optional docstring for my example bit field.
- pub u8 ExampleField
- /// Optional docstring for my flag enum.
- ExampleFlags {
- /// Optional docstring for Flag0
- 0 : Flag0,
- /// Optional docstring for Flag1
- 1 : Flag1,
- /// Optional docstring for Flag2
- 2 : Flag2,
- /// Optional docstring for Flag3
- 3 : Flag3,
- /// Optional docstring for Flag4
- 4 : Flag4,
- /// Optional docstring for Flag5
- 5 : Flag5,
- /// Optional docstring for Flag6
- 6 : Flag6,
- /// Optional docstring for Flag7
- 7 : Flag7,
+// -------------------------------------------------------------------------------------------------
+// Example
+
+#[allow(dead_code)]
+#[allow(unused_variables)]
+#[cfg(doc)]
+pub mod examples {
+ //! Examples of generated output using different configurations.
+ //!
+ //! __This module is only compiled with documentation builds
+ //! and will not be available for import.__
+ //!
+ //! use the [`bitfield`] macro to generate a field struct and flag enum.
+ //!
+
+ #[allow(dead_code)]
+ #[allow(unused_variables)]
+ #[cfg(doc)]
+ pub mod full_example {
+ //! Example of generated output, using both a bit field and a flag enum.
+ //!
+ //! __This module is only compiled with documentation builds
+ //! and will not be available for import.__
+ //!
+ //! use the [`bitfield`] macro to generate a field struct and flag enum.
+ //!
+ use super::*;
+
+ bitfield! {
+ /// Optional docstring for my example bit field.
+ pub u8 ExampleField
+ /// Optional docstring for my flag enum.
+ ExampleFlags {
+ /// Optional docstring for Flag0
+ 0 : Flag0,
+ /// Optional docstring for Flag1
+ 1 : Flag1,
+ /// Optional docstring for Flag2
+ 2 : Flag2,
+ /// Optional docstring for Flag3
+ 3 : Flag3,
+ /// Optional docstring for Flag4
+ 4 : Flag4,
+ /// Optional docstring for Flag5
+ 5 : Flag5,
+ /// Optional docstring for Flag6
+ 6 : Flag6,
+ /// Optional docstring for Flag7
+ 7 : Flag7,
}
}
}
- #[allow(dead_code)]
- #[allow(unused_variables)]
- #[cfg(doc)]
- pub mod flagless_example {
- //! Example of generated output, using only a bit field without a flag enum.
- //!
- //! __This module is only compiled with documentation builds
- //! and will not be available for import.__
- //!
- //! use the [`bitfield`] macro to generate a field struct and flag enum.
- //!
- use super::*;
-
- bitfield! {
- /// Optional docstring for my example bit field.
- pub u8 ExampleField
+ #[allow(dead_code)]
+ #[allow(unused_variables)]
+ #[cfg(doc)]
+ pub mod flagless_example {
+ //! Example of generated output, using only a bit field without a flag enum.
+ //!
+ //! __This module is only compiled with documentation builds
+ //! and will not be available for import.__
+ //!
+ //! use the [`bitfield`] macro to generate a field struct and flag enum.
+ //!
+ use super::*;
+
+ bitfield! {
+ /// Optional docstring for my example bit field.
+ pub u8 ExampleField
}
}
}
-// -------------------------------------------------------------------------------------------------
-// Tests
+// -------------------------------------------------------------------------------------------------
+// Tests
-#[allow(dead_code)]
-#[allow(unused_variables)]
-#[cfg(test)]
-mod test {
- use super::*;
- use std::{u128, u16, u32, u64, usize};
+#[allow(dead_code)]
+#[allow(unused_variables)]
+#[cfg(test)]
+mod test {
+ use super::*;
+ use std::{u128, u16, u32, u64, usize};
- macro_rules! tests {
- ( $( $name:ident => $block:block )+ ) => {
+ macro_rules! tests {
+ ( $( $name:ident => $block:block )+ ) => {
$(
- #[test]
- fn $name() $block
- )+
+ #[test]
+ fn $name() $block
+ )+
};
}
- bitfield! {
- /// My Test Thing
- u8 MyFieldU8
- MyFlagsU8 {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ bitfield! {
+ /// My Test Thing
+ u8 MyFieldU8
+ MyFlagsU8 {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
}
}
- bitfield! {
- /// My Test Thing
- u16 MyFieldU16
- MyFlagsU16 {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ bitfield! {
+ /// My Test Thing
+ u16 MyFieldU16
+ MyFlagsU16 {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
}
}
- bitfield! {
- /// My Test Thing
- u32 MyFieldU32
- MyFlagsU32 {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ bitfield! {
+ /// My Test Thing
+ u32 MyFieldU32
+ MyFlagsU32 {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
}
}
- bitfield! {
- /// My Test Thing
- u64 MyFieldU64
- MyFlagsU64 {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
- 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
- 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
- 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
- 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
+ bitfield! {
+ /// My Test Thing
+ u64 MyFieldU64
+ MyFlagsU64 {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
+ 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
+ 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
+ 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
}
}
- bitfield! {
- /// My Test Thing
- u128 MyFieldU128
- MyFlagsU128 {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
- 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
- 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
- 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
- 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
- 64 : Flag64, 65 : Flag65, 66 : Flag66, 67 : Flag67, 68 : Flag68, 69 : Flag69, 70 : Flag70, 71 : Flag71,
- 72 : Flag72, 73 : Flag73, 74 : Flag74, 75 : Flag75, 76 : Flag76, 77 : Flag77, 78 : Flag78, 79 : Flag79,
- 80 : Flag80, 81 : Flag81, 82 : Flag82, 83 : Flag83, 84 : Flag84, 85 : Flag85, 86 : Flag86, 87 : Flag87,
- 88 : Flag88, 89 : Flag89, 90 : Flag90, 91 : Flag91, 92 : Flag92, 93 : Flag93, 94 : Flag94, 95 : Flag95,
- 96 : Flag96, 97 : Flag97, 98 : Flag98, 99 : Flag99, 100 : Flag100, 101 : Flag101, 102 : Flag102, 103 : Flag103,
- 104 : Flag104, 105 : Flag105, 106 : Flag106, 107 : Flag107, 108 : Flag108, 109 : Flag109, 110 : Flag110, 111 : Flag111,
- 112 : Flag112, 113 : Flag113, 114 : Flag114, 115 : Flag115, 116 : Flag116, 117 : Flag117, 118 : Flag118, 119 : Flag119,
- 120 : Flag120, 121 : Flag121, 122 : Flag122, 123 : Flag123, 124 : Flag124, 125 : Flag125, 126 : Flag126, 127 : Flag127,
+ bitfield! {
+ /// My Test Thing
+ u128 MyFieldU128
+ MyFlagsU128 {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
+ 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
+ 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
+ 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
+ 64 : Flag64, 65 : Flag65, 66 : Flag66, 67 : Flag67, 68 : Flag68, 69 : Flag69, 70 : Flag70, 71 : Flag71,
+ 72 : Flag72, 73 : Flag73, 74 : Flag74, 75 : Flag75, 76 : Flag76, 77 : Flag77, 78 : Flag78, 79 : Flag79,
+ 80 : Flag80, 81 : Flag81, 82 : Flag82, 83 : Flag83, 84 : Flag84, 85 : Flag85, 86 : Flag86, 87 : Flag87,
+ 88 : Flag88, 89 : Flag89, 90 : Flag90, 91 : Flag91, 92 : Flag92, 93 : Flag93, 94 : Flag94, 95 : Flag95,
+ 96 : Flag96, 97 : Flag97, 98 : Flag98, 99 : Flag99, 100 : Flag100, 101 : Flag101, 102 : Flag102, 103 : Flag103,
+ 104 : Flag104, 105 : Flag105, 106 : Flag106, 107 : Flag107, 108 : Flag108, 109 : Flag109, 110 : Flag110, 111 : Flag111,
+ 112 : Flag112, 113 : Flag113, 114 : Flag114, 115 : Flag115, 116 : Flag116, 117 : Flag117, 118 : Flag118, 119 : Flag119,
+ 120 : Flag120, 121 : Flag121, 122 : Flag122, 123 : Flag123, 124 : Flag124, 125 : Flag125, 126 : Flag126, 127 : Flag127,
}
}
- #[cfg(target_pointer_width = "64")]
- bitfield! {
- /// My Test Thing
- usize MyFieldUsize
- MyFlagsUsize {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
- 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
- 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
- 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
- 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
+ #[cfg(target_pointer_width = "64")]
+ bitfield! {
+ /// My Test Thing
+ usize MyFieldUsize
+ MyFlagsUsize {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
+ 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
+ 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
+ 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
}
}
- #[cfg(target_pointer_width = "32")]
- bitfield! {
- /// My Test Thing
- usize MyFieldUsize
- MyFlagsUsize {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ #[cfg(target_pointer_width = "32")]
+ bitfield! {
+ /// My Test Thing
+ usize MyFieldUsize
+ MyFlagsUsize {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
}
}
- bitfield! {
- /// My Test Thing
- u8 MyFieldU8Nf
- MyFlagsU8Nf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ bitfield! {
+ /// My Test Thing
+ u8 MyFieldU8Nf
+ MyFlagsU8Nf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
}
}
- bitfield! {
- /// My Test Thing
- u16 MyFieldU16Nf
- MyFlagsU16Nf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ bitfield! {
+ /// My Test Thing
+ u16 MyFieldU16Nf
+ MyFlagsU16Nf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
}
}
- bitfield! {
- /// My Test Thing
- u32 MyFieldU32Nf
- MyFlagsU32Nf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ bitfield! {
+ /// My Test Thing
+ u32 MyFieldU32Nf
+ MyFlagsU32Nf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
}
}
- bitfield! {
- /// My Test Thing
- u64 MyFieldU64Nf
- MyFlagsU64Nf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
- 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
- 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
- 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
- 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
+ bitfield! {
+ /// My Test Thing
+ u64 MyFieldU64Nf
+ MyFlagsU64Nf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
+ 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
+ 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
+ 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
}
}
- bitfield! {
- /// My Test Thing
- u128 MyFieldU128Nf
- MyFlagsU128Nf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
- 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
- 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
- 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
- 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
- 64 : Flag64, 65 : Flag65, 66 : Flag66, 67 : Flag67, 68 : Flag68, 69 : Flag69, 70 : Flag70, 71 : Flag71,
- 72 : Flag72, 73 : Flag73, 74 : Flag74, 75 : Flag75, 76 : Flag76, 77 : Flag77, 78 : Flag78, 79 : Flag79,
- 80 : Flag80, 81 : Flag81, 82 : Flag82, 83 : Flag83, 84 : Flag84, 85 : Flag85, 86 : Flag86, 87 : Flag87,
- 88 : Flag88, 89 : Flag89, 90 : Flag90, 91 : Flag91, 92 : Flag92, 93 : Flag93, 94 : Flag94, 95 : Flag95,
- 96 : Flag96, 97 : Flag97, 98 : Flag98, 99 : Flag99, 100 : Flag100, 101 : Flag101, 102 : Flag102, 103 : Flag103,
- 104 : Flag104, 105 : Flag105, 106 : Flag106, 107 : Flag107, 108 : Flag108, 109 : Flag109, 110 : Flag110, 111 : Flag111,
- 112 : Flag112, 113 : Flag113, 114 : Flag114, 115 : Flag115, 116 : Flag116, 117 : Flag117, 118 : Flag118, 119 : Flag119,
- 120 : Flag120, 121 : Flag121, 122 : Flag122, 123 : Flag123, 124 : Flag124, 125 : Flag125, 126 : Flag126, 127 : Flag127,
+ bitfield! {
+ /// My Test Thing
+ u128 MyFieldU128Nf
+ MyFlagsU128Nf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
+ 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
+ 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
+ 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
+ 64 : Flag64, 65 : Flag65, 66 : Flag66, 67 : Flag67, 68 : Flag68, 69 : Flag69, 70 : Flag70, 71 : Flag71,
+ 72 : Flag72, 73 : Flag73, 74 : Flag74, 75 : Flag75, 76 : Flag76, 77 : Flag77, 78 : Flag78, 79 : Flag79,
+ 80 : Flag80, 81 : Flag81, 82 : Flag82, 83 : Flag83, 84 : Flag84, 85 : Flag85, 86 : Flag86, 87 : Flag87,
+ 88 : Flag88, 89 : Flag89, 90 : Flag90, 91 : Flag91, 92 : Flag92, 93 : Flag93, 94 : Flag94, 95 : Flag95,
+ 96 : Flag96, 97 : Flag97, 98 : Flag98, 99 : Flag99, 100 : Flag100, 101 : Flag101, 102 : Flag102, 103 : Flag103,
+ 104 : Flag104, 105 : Flag105, 106 : Flag106, 107 : Flag107, 108 : Flag108, 109 : Flag109, 110 : Flag110, 111 : Flag111,
+ 112 : Flag112, 113 : Flag113, 114 : Flag114, 115 : Flag115, 116 : Flag116, 117 : Flag117, 118 : Flag118, 119 : Flag119,
+ 120 : Flag120, 121 : Flag121, 122 : Flag122, 123 : Flag123, 124 : Flag124, 125 : Flag125, 126 : Flag126, 127 : Flag127,
}
}
- #[cfg(target_pointer_width = "64")]
- bitfield! {
- /// My Test Thing
- usize MyFieldUsizeNf
- MyFlagsUsizeNf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
- 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
- 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
- 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
- 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
+ #[cfg(target_pointer_width = "64")]
+ bitfield! {
+ /// My Test Thing
+ usize MyFieldUsizeNf
+ MyFlagsUsizeNf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ 32 : Flag32, 33 : Flag33, 34 : Flag34, 35 : Flag35, 36 : Flag36, 37 : Flag37, 38 : Flag38, 39 : Flag39,
+ 40 : Flag40, 41 : Flag41, 42 : Flag42, 43 : Flag43, 44 : Flag44, 45 : Flag45, 46 : Flag46, 47 : Flag47,
+ 48 : Flag48, 49 : Flag49, 50 : Flag50, 51 : Flag51, 52 : Flag52, 53 : Flag53, 54 : Flag54, 55 : Flag55,
+ 56 : Flag56, 57 : Flag57, 58 : Flag58, 59 : Flag59, 60 : Flag60, 61 : Flag61, 62 : Flag62, 63 : Flag63,
}
}
- #[cfg(target_pointer_width = "32")]
- bitfield! {
- /// My Test Thing
- usize MyFieldUsizeNf
- MyFlagsUsizeNf {
- 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
- 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
- 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
- 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
+ #[cfg(target_pointer_width = "32")]
+ bitfield! {
+ /// My Test Thing
+ usize MyFieldUsizeNf
+ MyFlagsUsizeNf {
+ 0 : Flag0, 1 : Flag1, 2 : Flag2, 3 : Flag3, 4 : Flag4, 5 : Flag5, 6 : Flag6, 7 : Flag7,
+ 8 : Flag8, 9 : Flag9, 10 : Flag10, 11 : Flag11, 12 : Flag12, 13 : Flag13, 14 : Flag14, 15 : Flag15,
+ 16 : Flag16, 17 : Flag17, 18 : Flag18, 19 : Flag19, 20 : Flag20, 21 : Flag21, 22 : Flag22, 23 : Flag23,
+ 24 : Flag24, 25 : Flag25, 26 : Flag26, 27 : Flag27, 28 : Flag28, 29 : Flag29, 30 : Flag30, 31 : Flag31,
}
}
- const U8: u8 = 123;
- const B8: &str = "01111011";
- const U16: u16 = 51526;
- const B16: &str = "1100100101000110";
- const U32: u32 = 2828091834;
- const B32: &str = "10101000100100010100000110111010";
- const U64: u64 = 18325744043706550615;
- const B64: &str = "1111111001010010000111110001110100100001110111000000100101010111";
- const U128: u128 = 160140183460469230739687303714882104727;
- const B128: &str = "01111000011110011110000010100001011000111110000100101011010111011111111110000110011101100010110100100000110001101010110110010111";
+ const U8: u8 = 123;
+ const B8: &str = "01111011";
+ const U16: u16 = 51526;
+ const B16: &str = "1100100101000110";
+ const U32: u32 = 2828091834;
+ const B32: &str = "10101000100100010100000110111010";
+ const U64: u64 = 18325744043706550615;
+ const B64: &str = "1111111001010010000111110001110100100001110111000000100101010111";
+ const U128: u128 = 160140183460469230739687303714882104727;
+ const B128: &str = "01111000011110011110000010100001011000111110000100101011010111011111111110000110011101100010110100100000110001101010110110010111";
- #[cfg(target_pointer_width = "64")]
- const USIZE: usize = 18325744043706550615;
- #[cfg(target_pointer_width = "64")]
- const BSIZE: &str = "1111111001010010000111110001110100100001110111000000100101010111";
+ #[cfg(target_pointer_width = "64")]
+ const USIZE: usize = 18325744043706550615;
+ #[cfg(target_pointer_width = "64")]
+ const BSIZE: &str = "1111111001010010000111110001110100100001110111000000100101010111";
- #[cfg(target_pointer_width = "32")]
- const USIZE: usize = 2828091834;
- #[cfg(target_pointer_width = "32")]
- const BSIZE: &str = "10101000100100010100000110111010";
+ #[cfg(target_pointer_width = "32")]
+ const USIZE: usize = 2828091834;
+ #[cfg(target_pointer_width = "32")]
+ const BSIZE: &str = "10101000100100010100000110111010";
- // constructors
- tests! {
- new_u8 => {
- MyFieldU8(U8);
+ // constructors
+ tests! {
+ new_u8 => {
+ MyFieldU8(U8);
}
- new_u16 => {
- MyFieldU16(U16);
+ new_u16 => {
+ MyFieldU16(U16);
}
- new_u32 => {
- MyFieldU32(U32);
+ new_u32 => {
+ MyFieldU32(U32);
}
- new_u64 => {
- MyFieldU64(U64);
+ new_u64 => {
+ MyFieldU64(U64);
}
- new_u128 => {
- MyFieldU128(U128);
+ new_u128 => {
+ MyFieldU128(U128);
}
- new_usize => {
- MyFieldUsize(USIZE);
+ new_usize => {
+ MyFieldUsize(USIZE);
}
}
- // from binary str
- tests! {
- from_binary_str_u8 => {
- assert_eq!(MyFieldU8::from_binary_str(B8), MyFieldU8(U8));
+ // from binary str
+ tests! {
+ from_binary_str_u8 => {
+ assert_eq!(MyFieldU8::from_binary_str(B8), MyFieldU8(U8));
}
- from_binary_str_u16 => {
- assert_eq!(MyFieldU16::from_binary_str(B16), MyFieldU16(U16));
+ from_binary_str_u16 => {
+ assert_eq!(MyFieldU16::from_binary_str(B16), MyFieldU16(U16));
}
- from_binary_str_u32 => {
- assert_eq!(MyFieldU32::from_binary_str(B32), MyFieldU32(U32));
+ from_binary_str_u32 => {
+ assert_eq!(MyFieldU32::from_binary_str(B32), MyFieldU32(U32));
}
- from_binary_str_u64 => {
- assert_eq!(MyFieldU64::from_binary_str(B64), MyFieldU64(U64));
+ from_binary_str_u64 => {
+ assert_eq!(MyFieldU64::from_binary_str(B64), MyFieldU64(U64));
}
- from_binary_str_u128 => {
- assert_eq!(MyFieldU128::from_binary_str(B128), MyFieldU128(U128));
+ from_binary_str_u128 => {
+ assert_eq!(MyFieldU128::from_binary_str(B128), MyFieldU128(U128));
}
- from_binary_str_usize => {
- assert_eq!(MyFieldUsize::from_binary_str(BSIZE), MyFieldUsize(USIZE));
+ from_binary_str_usize => {
+ assert_eq!(MyFieldUsize::from_binary_str(BSIZE), MyFieldUsize(USIZE));
}
}
- // from binary string
- tests! {
- from_binary_string_u8 => {
- assert_eq!(MyFieldU8::from_binary_string(String::from(B8)), MyFieldU8(U8));
+ // from binary string
+ tests! {
+ from_binary_string_u8 => {
+ assert_eq!(MyFieldU8::from_binary_string(String::from(B8)), MyFieldU8(U8));
}
- from_binary_string_u16 => {
- assert_eq!(MyFieldU16::from_binary_string(String::from(B16)), MyFieldU16(U16));
+ from_binary_string_u16 => {
+ assert_eq!(MyFieldU16::from_binary_string(String::from(B16)), MyFieldU16(U16));
}
- from_binary_string_u32 => {
- assert_eq!(MyFieldU32::from_binary_string(String::from(B32)), MyFieldU32(U32));
+ from_binary_string_u32 => {
+ assert_eq!(MyFieldU32::from_binary_string(String::from(B32)), MyFieldU32(U32));
}
- from_binary_string_u64 => {
- assert_eq!(MyFieldU64::from_binary_string(String::from(B64)), MyFieldU64(U64));
+ from_binary_string_u64 => {
+ assert_eq!(MyFieldU64::from_binary_string(String::from(B64)), MyFieldU64(U64));
}
- from_binary_string_u128 => {
- assert_eq!(MyFieldU128::from_binary_string(String::from(B128)), MyFieldU128(U128));
+ from_binary_string_u128 => {
+ assert_eq!(MyFieldU128::from_binary_string(String::from(B128)), MyFieldU128(U128));
}
- from_binary_string_usize => {
- assert_eq!(MyFieldUsize::from_binary_string(String::from(BSIZE)), MyFieldUsize(USIZE));
+ from_binary_string_usize => {
+ assert_eq!(MyFieldUsize::from_binary_string(String::from(BSIZE)), MyFieldUsize(USIZE));
}
}
- // ones
- tests! {
- ones_u8 => {
- assert_eq!(MyFieldU8::ones(), MyFieldU8(u8::MAX));
+ // ones
+ tests! {
+ ones_u8 => {
+ assert_eq!(MyFieldU8::ones(), MyFieldU8(u8::MAX));
}
- ones_u16 => {
- assert_eq!(MyFieldU16::ones(), MyFieldU16(u16::MAX));
+ ones_u16 => {
+ assert_eq!(MyFieldU16::ones(), MyFieldU16(u16::MAX));
}
- ones_u32 => {
- assert_eq!(MyFieldU32::ones(), MyFieldU32(u32::MAX));
+ ones_u32 => {
+ assert_eq!(MyFieldU32::ones(), MyFieldU32(u32::MAX));
}
- ones_u64 => {
- assert_eq!(MyFieldU64::ones(), MyFieldU64(u64::MAX));
+ ones_u64 => {
+ assert_eq!(MyFieldU64::ones(), MyFieldU64(u64::MAX));
}
- ones_u128 => {
- assert_eq!(MyFieldU128::ones(), MyFieldU128(u128::MAX));
+ ones_u128 => {
+ assert_eq!(MyFieldU128::ones(), MyFieldU128(u128::MAX));
}
- ones_usize => {
- assert_eq!(MyFieldUsize::ones(), MyFieldUsize(usize::MAX));
+ ones_usize => {
+ assert_eq!(MyFieldUsize::ones(), MyFieldUsize(usize::MAX));
}
}
- // zeros
- tests! {
- zeros_u8 => {
- assert_eq!(MyFieldU8::zeros(), MyFieldU8(0));
+ // zeros
+ tests! {
+ zeros_u8 => {
+ assert_eq!(MyFieldU8::zeros(), MyFieldU8(0));
}
- zeros_u16 => {
- assert_eq!(MyFieldU16::zeros(), MyFieldU16(0));
+ zeros_u16 => {
+ assert_eq!(MyFieldU16::zeros(), MyFieldU16(0));
}
- zeros_u32 => {
- assert_eq!(MyFieldU32::zeros(), MyFieldU32(0));
+ zeros_u32 => {
+ assert_eq!(MyFieldU32::zeros(), MyFieldU32(0));
}
- zeros_u64 => {
- assert_eq!(MyFieldU64::zeros(), MyFieldU64(0));
+ zeros_u64 => {
+ assert_eq!(MyFieldU64::zeros(), MyFieldU64(0));
}
- zeros_u128 => {
- assert_eq!(MyFieldU128::zeros(), MyFieldU128(0));
+ zeros_u128 => {
+ assert_eq!(MyFieldU128::zeros(), MyFieldU128(0));
}
- zeros_usize => {
- assert_eq!(MyFieldUsize::zeros(), MyFieldUsize(0));
+ zeros_usize => {
+ assert_eq!(MyFieldUsize::zeros(), MyFieldUsize(0));
}
}
- // defaults
- tests! {
- default_u8 => {
- assert_eq!(0, MyFieldU8::default().as_integer())
+ // defaults
+ tests! {
+ default_u8 => {
+ assert_eq!(0, MyFieldU8::default().as_integer())
}
- default_u16 => {
- assert_eq!(0, MyFieldU16::default().as_integer())
+ default_u16 => {
+ assert_eq!(0, MyFieldU16::default().as_integer())
}
- default_u32 => {
- assert_eq!(0, MyFieldU32::default().as_integer())
+ default_u32 => {
+ assert_eq!(0, MyFieldU32::default().as_integer())
}
- default_u64 => {
- assert_eq!(0, MyFieldU64::default().as_integer())
+ default_u64 => {
+ assert_eq!(0, MyFieldU64::default().as_integer())
}
- default_u128 => {
- assert_eq!(0, MyFieldU128::default().as_integer())
+ default_u128 => {
+ assert_eq!(0, MyFieldU128::default().as_integer())
}
- default_usize => {
- assert_eq!(0, MyFieldUsize::default().as_integer())
+ default_usize => {
+ assert_eq!(0, MyFieldUsize::default().as_integer())
}
}
- // bit count
- tests! {
- bit_count_u8 => {
- let field = MyFieldU8(U8);
- assert_eq!(u8::BITS as usize, MyFieldU8::BITS)
+ // bit count
+ tests! {
+ bit_count_u8 => {
+ let field = MyFieldU8(U8);
+ assert_eq!(u8::BITS as usize, MyFieldU8::BITS)
}
- bit_count_u16 => {
- let field = MyFieldU16(U16);
- assert_eq!(u16::BITS as usize, MyFieldU16::BITS)
+ bit_count_u16 => {
+ let field = MyFieldU16(U16);
+ assert_eq!(u16::BITS as usize, MyFieldU16::BITS)
}
- bit_count_u32 => {
- let field = MyFieldU32(U32);
- assert_eq!(u32::BITS as usize, MyFieldU32::BITS)
+ bit_count_u32 => {
+ let field = MyFieldU32(U32);
+ assert_eq!(u32::BITS as usize, MyFieldU32::BITS)
}
- bit_count_u64 => {
- let field = MyFieldU64(U64);
- assert_eq!(u64::BITS as usize, MyFieldU64::BITS)
+ bit_count_u64 => {
+ let field = MyFieldU64(U64);
+ assert_eq!(u64::BITS as usize, MyFieldU64::BITS)
}
- bit_count_u128 => {
- let field = MyFieldU128(U128);
- assert_eq!(u128::BITS as usize, MyFieldU128::BITS)
+ bit_count_u128 => {
+ let field = MyFieldU128(U128);
+ assert_eq!(u128::BITS as usize, MyFieldU128::BITS)
}
- bit_count_usize => {
- let field = MyFieldUsize(USIZE);
- assert_eq!(usize::BITS as usize, MyFieldUsize::BITS)
+ bit_count_usize => {
+ let field = MyFieldUsize(USIZE);
+ assert_eq!(usize::BITS as usize, MyFieldUsize::BITS)
}
}
- // byte count
- tests! {
- byte_count_u8 => {
- let field = MyFieldU8(U8);
- assert_eq!(1, MyFieldU8::BYTES)
+ // byte count
+ tests! {
+ byte_count_u8 => {
+ let field = MyFieldU8(U8);
+ assert_eq!(1, MyFieldU8::BYTES)
}
- byte_count_u16 => {
- let field = MyFieldU16(U16);
- assert_eq!(2, MyFieldU16::BYTES)
+ byte_count_u16 => {
+ let field = MyFieldU16(U16);
+ assert_eq!(2, MyFieldU16::BYTES)
}
- byte_count_u32 => {
- let field = MyFieldU32(U32);
- assert_eq!(4, MyFieldU32::BYTES)
+ byte_count_u32 => {
+ let field = MyFieldU32(U32);
+ assert_eq!(4, MyFieldU32::BYTES)
}
- byte_count_u64 => {
- let field = MyFieldU64(U64);
- assert_eq!(8, MyFieldU64::BYTES)
+ byte_count_u64 => {
+ let field = MyFieldU64(U64);
+ assert_eq!(8, MyFieldU64::BYTES)
}
- byte_count_u128 => {
- let field = MyFieldU128(U128);
- assert_eq!(16, MyFieldU128::BYTES)
+ byte_count_u128 => {
+ let field = MyFieldU128(U128);
+ assert_eq!(16, MyFieldU128::BYTES)
}
- byte_count_usize => {
- let field = MyFieldUsize(USIZE);
- assert_eq!((usize::BITS as usize) / 8, MyFieldUsize::BYTES)
+ byte_count_usize => {
+ let field = MyFieldUsize(USIZE);
+ assert_eq!((usize::BITS as usize) / 8, MyFieldUsize::BYTES)
}
}
- // integer value
- tests! {
- integer_u8 => {
- let field = MyFieldU8(U8);
- assert_eq!(U8, field.as_integer())
+ // integer value
+ tests! {
+ integer_u8 => {
+ let field = MyFieldU8(U8);
+ assert_eq!(U8, field.as_integer())
}
- integer_u16 => {
- let field = MyFieldU16(U16);
- assert_eq!(U16, field.as_integer())
+ integer_u16 => {
+ let field = MyFieldU16(U16);
+ assert_eq!(U16, field.as_integer())
}
- integer_u32 => {
- let field = MyFieldU32(U32);
- assert_eq!(U32, field.as_integer())
+ integer_u32 => {
+ let field = MyFieldU32(U32);
+ assert_eq!(U32, field.as_integer())
}
- integer_u64 => {
- let field = MyFieldU64(U64);
- assert_eq!(U64, field.as_integer())
+ integer_u64 => {
+ let field = MyFieldU64(U64);
+ assert_eq!(U64, field.as_integer())
}
- integer_u128 => {
- let field = MyFieldU128(U128);
- assert_eq!(U128, field.as_integer())
+ integer_u128 => {
+ let field = MyFieldU128(U128);
+ assert_eq!(U128, field.as_integer())
}
- integer_usize => {
- let field = MyFieldUsize(USIZE);
- assert_eq!(USIZE, field.as_integer())
+ integer_usize => {
+ let field = MyFieldUsize(USIZE);
+ assert_eq!(USIZE, field.as_integer())
}
}
- // binary value
- tests! {
- binary_u8 => {
- let field = MyFieldU8(U8);
- assert_eq!(B8, field.as_binary())
+ // binary value
+ tests! {
+ binary_u8 => {
+ let field = MyFieldU8(U8);
+ assert_eq!(B8, field.as_binary())
}
- binary_u16 => {
- let field = MyFieldU16(U16);
- assert_eq!(B16, field.as_binary())
+ binary_u16 => {
+ let field = MyFieldU16(U16);
+ assert_eq!(B16, field.as_binary())
}
- binary_u32 => {
- let field = MyFieldU32(U32);
- assert_eq!(B32, field.as_binary())
+ binary_u32 => {
+ let field = MyFieldU32(U32);
+ assert_eq!(B32, field.as_binary())
}
- binary_u64 => {
- let field = MyFieldU64(U64);
- assert_eq!(B64, field.as_binary())
+ binary_u64 => {
+ let field = MyFieldU64(U64);
+ assert_eq!(B64, field.as_binary())
}
- binary_u128 => {
- let field = MyFieldU128(U128);
- assert_eq!(B128, field.as_binary())
+ binary_u128 => {
+ let field = MyFieldU128(U128);
+ assert_eq!(B128, field.as_binary())
}
- binary_usize => {
- let field = MyFieldUsize(USIZE);
- assert_eq!(BSIZE, field.as_binary())
+ binary_usize => {
+ let field = MyFieldUsize(USIZE);
+ assert_eq!(BSIZE, field.as_binary())
}
}
- // get index
- tests! {
- get_index_u8 => {
- let field = MyFieldU8(U8);
- for (index, char) in B8.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8))
- } else if char == '0' {
- assert!(!field.get_index(index as u8))
- } else {
+ // get index
+ tests! {
+ get_index_u8 => {
+ let field = MyFieldU8(U8);
+ for (index, char) in B8.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8))
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_index_u16 => {
- let field = MyFieldU16(U16);
- for (index, char) in B16.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8))
- } else if char == '0' {
- assert!(!field.get_index(index as u8))
- } else {
+ get_index_u16 => {
+ let field = MyFieldU16(U16);
+ for (index, char) in B16.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8))
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_index_u32 => {
- let field = MyFieldU32(U32);
- for (index, char) in B32.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8))
- } else if char == '0' {
- assert!(!field.get_index(index as u8))
- } else {
+ get_index_u32 => {
+ let field = MyFieldU32(U32);
+ for (index, char) in B32.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8))
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_index_u64 => {
- let field = MyFieldU64(U64);
- for (index, char) in B64.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8))
- } else if char == '0' {
- assert!(!field.get_index(index as u8))
- } else {
+ get_index_u64 => {
+ let field = MyFieldU64(U64);
+ for (index, char) in B64.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8))
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_index_u128 => {
- let field = MyFieldU128(U128);
- for (index, char) in B128.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8))
- } else if char == '0' {
- assert!(!field.get_index(index as u8))
- } else {
+ get_index_u128 => {
+ let field = MyFieldU128(U128);
+ for (index, char) in B128.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8))
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_index_usize => {
- let field = MyFieldUsize(USIZE);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8))
- } else if char == '0' {
- assert!(!field.get_index(index as u8))
- } else {
+ get_index_usize => {
+ let field = MyFieldUsize(USIZE);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8))
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8))
+ } else {
panic!("invalid char in binary string")
}
}
}
}
- // set index
- tests! {
- set_index_u8 => {
- let mut field = MyFieldU8(0);
- for (index, char) in B8.chars().rev().enumerate() {
- field.set_index(index as u8);
- for (s_index, _char) in B8.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ // set index
+ tests! {
+ set_index_u8 => {
+ let mut field = MyFieldU8(0);
+ for (index, char) in B8.chars().rev().enumerate() {
+ field.set_index(index as u8);
+ for (s_index, _char) in B8.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_index_u16 => {
- let mut field = MyFieldU16(0);
- for (index, char) in B16.chars().rev().enumerate() {
- field.set_index(index as u8);
- for (s_index, _char) in B16.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_index_u16 => {
+ let mut field = MyFieldU16(0);
+ for (index, char) in B16.chars().rev().enumerate() {
+ field.set_index(index as u8);
+ for (s_index, _char) in B16.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_index_u32 => {
- let mut field = MyFieldU32(0);
- for (index, char) in B32.chars().rev().enumerate() {
- field.set_index(index as u8);
- for (s_index, _char) in B32.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_index_u32 => {
+ let mut field = MyFieldU32(0);
+ for (index, char) in B32.chars().rev().enumerate() {
+ field.set_index(index as u8);
+ for (s_index, _char) in B32.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_index_u64 => {
- let mut field = MyFieldU64(0);
- for (index, char) in B64.chars().rev().enumerate() {
- field.set_index(index as u8);
- for (s_index, _char) in B64.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_index_u64 => {
+ let mut field = MyFieldU64(0);
+ for (index, char) in B64.chars().rev().enumerate() {
+ field.set_index(index as u8);
+ for (s_index, _char) in B64.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_index_u128 => {
- let mut field = MyFieldU128(0);
- for (index, char) in B128.chars().rev().enumerate() {
- field.set_index(index as u8);
- for (s_index, _char) in B128.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_index_u128 => {
+ let mut field = MyFieldU128(0);
+ for (index, char) in B128.chars().rev().enumerate() {
+ field.set_index(index as u8);
+ for (s_index, _char) in B128.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_index_usize => {
- let mut field = MyFieldUsize(0);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- field.set_index(index as u8);
- for (s_index, _char) in BSIZE.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_index_usize => {
+ let mut field = MyFieldUsize(0);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ field.set_index(index as u8);
+ for (s_index, _char) in BSIZE.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
}
- // clear index
- tests! {
- clear_index_u8 => {
- let mut field = MyFieldU8(u8::MAX);
- for (index, char) in B8.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear_index(index as u8);
- for (s_index, _char) in B8.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ // clear index
+ tests! {
+ clear_index_u8 => {
+ let mut field = MyFieldU8(u8::MAX);
+ for (index, char) in B8.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear_index(index as u8);
+ for (s_index, _char) in B8.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_index_u16 => {
- let mut field = MyFieldU16(u16::MAX);
- for (index, char) in B16.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear_index(index as u8);
- for (s_index, _char) in B16.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_index_u16 => {
+ let mut field = MyFieldU16(u16::MAX);
+ for (index, char) in B16.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear_index(index as u8);
+ for (s_index, _char) in B16.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_index_u32 => {
- let mut field = MyFieldU32(u32::MAX);
- for (index, char) in B32.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear_index(index as u8);
- for (s_index, _char) in B32.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_index_u32 => {
+ let mut field = MyFieldU32(u32::MAX);
+ for (index, char) in B32.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear_index(index as u8);
+ for (s_index, _char) in B32.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_index_u64 => {
- let mut field = MyFieldU64(u64::MAX);
- for (index, char) in B64.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear_index(index as u8);
- for (s_index, _char) in B64.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_index_u64 => {
+ let mut field = MyFieldU64(u64::MAX);
+ for (index, char) in B64.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear_index(index as u8);
+ for (s_index, _char) in B64.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_index_u128 => {
- let mut field = MyFieldU128(u128::MAX);
- for (index, char) in B128.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear_index(index as u8);
- for (s_index, _char) in B128.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_index_u128 => {
+ let mut field = MyFieldU128(u128::MAX);
+ for (index, char) in B128.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear_index(index as u8);
+ for (s_index, _char) in B128.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_index_usize => {
- let mut field = MyFieldUsize(usize::MAX);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear_index(index as u8);
- for (s_index, _char) in BSIZE.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_index_usize => {
+ let mut field = MyFieldUsize(usize::MAX);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear_index(index as u8);
+ for (s_index, _char) in BSIZE.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
}
- // toggle index
- tests! {
- toggle_index_u8 => {
- let mut field = MyFieldU8(U8);
- for (index, char) in B8.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(field.get_index(index as u8));
- } else {
+ // toggle index
+ tests! {
+ toggle_index_u8 => {
+ let mut field = MyFieldU8(U8);
+ for (index, char) in B8.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string");
}
}
}
- toggle_index_u16 => {
- let mut field = MyFieldU16(U16);
- for (index, char) in B16.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(field.get_index(index as u8));
- } else {
+ toggle_index_u16 => {
+ let mut field = MyFieldU16(U16);
+ for (index, char) in B16.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_index_u32 => {
- let mut field = MyFieldU32(U32);
- for (index, char) in B32.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(field.get_index(index as u8));
- } else {
+ toggle_index_u32 => {
+ let mut field = MyFieldU32(U32);
+ for (index, char) in B32.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_index_u64 => {
- let mut field = MyFieldU64(U64);
- for (index, char) in B64.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(field.get_index(index as u8));
- } else {
+ toggle_index_u64 => {
+ let mut field = MyFieldU64(U64);
+ for (index, char) in B64.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_index_u128 => {
- let mut field = MyFieldU128(U128);
- for (index, char) in B128.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(field.get_index(index as u8));
- } else {
+ toggle_index_u128 => {
+ let mut field = MyFieldU128(U128);
+ for (index, char) in B128.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_index_usize => {
- let mut field = MyFieldUsize(USIZE);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle_index(index as u8);
- assert!(field.get_index(index as u8));
- } else {
+ toggle_index_usize => {
+ let mut field = MyFieldUsize(USIZE);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle_index(index as u8);
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
}
- // get
- tests! {
- get_u8 => {
- let field = MyFieldU8(U8);
- for (index, char) in B8.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get(MyFlagsU8::from(index as u8)))
- } else if char == '0' {
- assert!(!field.get(MyFlagsU8::from(index as u8)))
- } else {
+ // get
+ tests! {
+ get_u8 => {
+ let field = MyFieldU8(U8);
+ for (index, char) in B8.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get(MyFlagsU8::from(index as u8)))
+ } else if char == '0' {
+ assert!(!field.get(MyFlagsU8::from(index as u8)))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_u16 => {
- let field = MyFieldU16(U16);
- for (index, char) in B16.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get(MyFlagsU16::from(index as u8)))
- } else if char == '0' {
- assert!(!field.get(MyFlagsU16::from(index as u8)))
- } else {
+ get_u16 => {
+ let field = MyFieldU16(U16);
+ for (index, char) in B16.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get(MyFlagsU16::from(index as u8)))
+ } else if char == '0' {
+ assert!(!field.get(MyFlagsU16::from(index as u8)))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_u32 => {
- let field = MyFieldU32(U32);
- for (index, char) in B32.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get(MyFlagsU32::from(index as u8)))
- } else if char == '0' {
- assert!(!field.get(MyFlagsU32::from(index as u8)))
- } else {
+ get_u32 => {
+ let field = MyFieldU32(U32);
+ for (index, char) in B32.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get(MyFlagsU32::from(index as u8)))
+ } else if char == '0' {
+ assert!(!field.get(MyFlagsU32::from(index as u8)))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_u64 => {
- let field = MyFieldU64(U64);
- for (index, char) in B64.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get(MyFlagsU64::from(index as u8)))
- } else if char == '0' {
- assert!(!field.get(MyFlagsU64::from(index as u8)))
- } else {
+ get_u64 => {
+ let field = MyFieldU64(U64);
+ for (index, char) in B64.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get(MyFlagsU64::from(index as u8)))
+ } else if char == '0' {
+ assert!(!field.get(MyFlagsU64::from(index as u8)))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_u128 => {
- let field = MyFieldU128(U128);
- for (index, char) in B128.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get(MyFlagsU128::from(index as u8)))
- } else if char == '0' {
- assert!(!field.get(MyFlagsU128::from(index as u8)))
- } else {
+ get_u128 => {
+ let field = MyFieldU128(U128);
+ for (index, char) in B128.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get(MyFlagsU128::from(index as u8)))
+ } else if char == '0' {
+ assert!(!field.get(MyFlagsU128::from(index as u8)))
+ } else {
panic!("invalid char in binary string")
}
}
}
- get_usize => {
- let field = MyFieldUsize(USIZE);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get(MyFlagsUsize::from(index as u8)))
- } else if char == '0' {
- assert!(!field.get(MyFlagsUsize::from(index as u8)))
- } else {
+ get_usize => {
+ let field = MyFieldUsize(USIZE);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get(MyFlagsUsize::from(index as u8)))
+ } else if char == '0' {
+ assert!(!field.get(MyFlagsUsize::from(index as u8)))
+ } else {
panic!("invalid char in binary string")
}
}
}
}
- // set
- tests! {
- set_u8 => {
- let mut field = MyFieldU8(0);
- for (index, char) in B8.chars().rev().enumerate() {
- field.set(MyFlagsU8::from(index as u8));
- for (s_index, _char) in B8.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ // set
+ tests! {
+ set_u8 => {
+ let mut field = MyFieldU8(0);
+ for (index, char) in B8.chars().rev().enumerate() {
+ field.set(MyFlagsU8::from(index as u8));
+ for (s_index, _char) in B8.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_u16 => {
- let mut field = MyFieldU16(0);
- for (index, char) in B16.chars().rev().enumerate() {
- field.set(MyFlagsU16::from(index as u8));
- for (s_index, _char) in B16.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_u16 => {
+ let mut field = MyFieldU16(0);
+ for (index, char) in B16.chars().rev().enumerate() {
+ field.set(MyFlagsU16::from(index as u8));
+ for (s_index, _char) in B16.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_u32 => {
- let mut field = MyFieldU32(0);
- for (index, char) in B32.chars().rev().enumerate() {
- field.set(MyFlagsU32::from(index as u8));
- for (s_index, _char) in B32.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_u32 => {
+ let mut field = MyFieldU32(0);
+ for (index, char) in B32.chars().rev().enumerate() {
+ field.set(MyFlagsU32::from(index as u8));
+ for (s_index, _char) in B32.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_u64 => {
- let mut field = MyFieldU64(0);
- for (index, char) in B64.chars().rev().enumerate() {
- field.set(MyFlagsU64::from(index as u8));
- for (s_index, _char) in B64.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_u64 => {
+ let mut field = MyFieldU64(0);
+ for (index, char) in B64.chars().rev().enumerate() {
+ field.set(MyFlagsU64::from(index as u8));
+ for (s_index, _char) in B64.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_u128 => {
- let mut field = MyFieldU128(0);
- for (index, char) in B128.chars().rev().enumerate() {
- field.set(MyFlagsU128::from(index as u8));
- for (s_index, _char) in B128.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_u128 => {
+ let mut field = MyFieldU128(0);
+ for (index, char) in B128.chars().rev().enumerate() {
+ field.set(MyFlagsU128::from(index as u8));
+ for (s_index, _char) in B128.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- set_usize => {
- let mut field = MyFieldUsize(0);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- field.set(MyFlagsUsize::from(index as u8));
- for (s_index, _char) in BSIZE.chars().rev().enumerate() {
- if s_index <= index {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ set_usize => {
+ let mut field = MyFieldUsize(0);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ field.set(MyFlagsUsize::from(index as u8));
+ for (s_index, _char) in BSIZE.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
}
- // clear
- tests! {
- clear_u8 => {
- let mut field = MyFieldU8(u8::MAX);
- for (index, char) in B8.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear(MyFlagsU8::from(index as u8));
- for (s_index, _char) in B8.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ // clear
+ tests! {
+ clear_u8 => {
+ let mut field = MyFieldU8(u8::MAX);
+ for (index, char) in B8.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear(MyFlagsU8::from(index as u8));
+ for (s_index, _char) in B8.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_u16 => {
- let mut field = MyFieldU16(u16::MAX);
- for (index, char) in B16.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear(MyFlagsU16::from(index as u8));
- for (s_index, _char) in B16.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_u16 => {
+ let mut field = MyFieldU16(u16::MAX);
+ for (index, char) in B16.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear(MyFlagsU16::from(index as u8));
+ for (s_index, _char) in B16.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_u32 => {
- let mut field = MyFieldU32(u32::MAX);
- for (index, char) in B32.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear(MyFlagsU32::from(index as u8));
- for (s_index, _char) in B32.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_u32 => {
+ let mut field = MyFieldU32(u32::MAX);
+ for (index, char) in B32.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear(MyFlagsU32::from(index as u8));
+ for (s_index, _char) in B32.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_u64 => {
- let mut field = MyFieldU64(u64::MAX);
- for (index, char) in B64.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear(MyFlagsU64::from(index as u8));
- for (s_index, _char) in B64.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_u64 => {
+ let mut field = MyFieldU64(u64::MAX);
+ for (index, char) in B64.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear(MyFlagsU64::from(index as u8));
+ for (s_index, _char) in B64.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_u128 => {
- let mut field = MyFieldU128(u128::MAX);
- for (index, char) in B128.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear(MyFlagsU128::from(index as u8));
- for (s_index, _char) in B128.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_u128 => {
+ let mut field = MyFieldU128(u128::MAX);
+ for (index, char) in B128.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear(MyFlagsU128::from(index as u8));
+ for (s_index, _char) in B128.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
- clear_usize => {
- let mut field = MyFieldUsize(usize::MAX);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- assert!(field.get_index(index as u8), "{:#?}", field);
- field.clear(MyFlagsUsize::from(index as u8));
- for (s_index, _char) in BSIZE.chars().rev().enumerate() {
- if s_index <= index {
- assert!(!field.get_index(s_index as u8), "{:#?}", field);
- } else {
- assert!(field.get_index(s_index as u8), "{:#?}", field);
+ clear_usize => {
+ let mut field = MyFieldUsize(usize::MAX);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ assert!(field.get_index(index as u8), "{:#?}", field);
+ field.clear(MyFlagsUsize::from(index as u8));
+ for (s_index, _char) in BSIZE.chars().rev().enumerate() {
+ if s_index <= index {
+ assert!(!field.get_index(s_index as u8), "{:#?}", field);
+ } else {
+ assert!(field.get_index(s_index as u8), "{:#?}", field);
}
}
}
}
}
- // toggle
- tests! {
- toggle_u8 => {
- let mut field = MyFieldU8(U8);
- for (index, char) in B8.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle(MyFlagsU8::from(index as u8));
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle(MyFlagsU8::from(index as u8));
- assert!(field.get_index(index as u8));
- } else {
+ // toggle
+ tests! {
+ toggle_u8 => {
+ let mut field = MyFieldU8(U8);
+ for (index, char) in B8.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle(MyFlagsU8::from(index as u8));
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle(MyFlagsU8::from(index as u8));
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string");
}
}
}
- toggle_u16 => {
- let mut field = MyFieldU16(U16);
- for (index, char) in B16.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle(MyFlagsU16::from(index as u8));
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle(MyFlagsU16::from(index as u8));
- assert!(field.get_index(index as u8));
- } else {
+ toggle_u16 => {
+ let mut field = MyFieldU16(U16);
+ for (index, char) in B16.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle(MyFlagsU16::from(index as u8));
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle(MyFlagsU16::from(index as u8));
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_u32 => {
- let mut field = MyFieldU32(U32);
- for (index, char) in B32.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle(MyFlagsU32::from(index as u8));
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle(MyFlagsU32::from(index as u8));
- assert!(field.get_index(index as u8));
- } else {
+ toggle_u32 => {
+ let mut field = MyFieldU32(U32);
+ for (index, char) in B32.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle(MyFlagsU32::from(index as u8));
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle(MyFlagsU32::from(index as u8));
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_u64 => {
- let mut field = MyFieldU64(U64);
- for (index, char) in B64.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle(MyFlagsU64::from(index as u8));
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle(MyFlagsU64::from(index as u8));
- assert!(field.get_index(index as u8));
- } else {
+ toggle_u64 => {
+ let mut field = MyFieldU64(U64);
+ for (index, char) in B64.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle(MyFlagsU64::from(index as u8));
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle(MyFlagsU64::from(index as u8));
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_u128 => {
- let mut field = MyFieldU128(U128);
- for (index, char) in B128.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle(MyFlagsU128::from(index as u8));
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle(MyFlagsU128::from(index as u8));
- assert!(field.get_index(index as u8));
- } else {
+ toggle_u128 => {
+ let mut field = MyFieldU128(U128);
+ for (index, char) in B128.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle(MyFlagsU128::from(index as u8));
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle(MyFlagsU128::from(index as u8));
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
- toggle_usize => {
- let mut field = MyFieldUsize(USIZE);
- for (index, char) in BSIZE.chars().rev().enumerate() {
- if char == '1' {
- assert!(field.get_index(index as u8));
- field.toggle(MyFlagsUsize::from(index as u8));
- assert!(!field.get_index(index as u8));
- } else if char == '0' {
- assert!(!field.get_index(index as u8));
- field.toggle(MyFlagsUsize::from(index as u8));
- assert!(field.get_index(index as u8));
- } else {
+ toggle_usize => {
+ let mut field = MyFieldUsize(USIZE);
+ for (index, char) in BSIZE.chars().rev().enumerate() {
+ if char == '1' {
+ assert!(field.get_index(index as u8));
+ field.toggle(MyFlagsUsize::from(index as u8));
+ assert!(!field.get_index(index as u8));
+ } else if char == '0' {
+ assert!(!field.get_index(index as u8));
+ field.toggle(MyFlagsUsize::from(index as u8));
+ assert!(field.get_index(index as u8));
+ } else {
panic!("invalid char in binary string")
}
}
}
}
- // diff
- tests! {
- diff_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.diff(reversed);
- assert_eq!("10100101", out.as_binary());
- assert_eq!(165, out.as_integer());
- }
- diff_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.diff(reversed);
- assert_eq!("1010101111010101", out.as_binary());
- assert_eq!(43989, out.as_integer());
- }
- diff_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.diff(reversed);
- assert_eq!("11110101000100111100100010101111", out.as_binary());
- assert_eq!(4111714479, out.as_integer());
- }
- diff_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.diff(reversed);
- assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", out.as_binary());
- assert_eq!(1495798268358312744, out.as_integer());
- }
- diff_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.diff(reversed);
- assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", out.as_binary());
- assert_eq!(193799958082971305581995159990093034377, out.as_integer());
- }
- // diff_usize => {
- // let field = MyFieldUsize(USIZE);
- // }
- }
-
- // combine
- tests! {
- combine_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.combine(reversed);
- assert_eq!("11111111", out.as_binary());
- assert_eq!(255, out.as_integer());
- }
- combine_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.combine(reversed);
- assert_eq!("1110101111010111", out.as_binary());
- assert_eq!(60375, out.as_integer());
- }
- combine_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.combine(reversed);
- assert_eq!("11111101100100111100100110111111", out.as_binary());
- assert_eq!(4254321087, out.as_integer());
- }
- combine_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.combine(reversed);
- assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", out.as_binary());
- assert_eq!(18361808577405668223, out.as_integer());
- }
- combine_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.combine(reversed);
- assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", out.as_binary());
- assert_eq!(332296039312012448238196841470979719071, out.as_integer());
- }
- // combine_usize => {
- // let field = MyFieldUsize(USIZE);
- // }
- }
-
- // intersect
- tests! {
- intersect_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.intersect(reversed);
- assert_eq!("01011010", out.as_binary());
- assert_eq!(90, out.as_integer());
- }
- intersect_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.intersect(reversed);
- assert_eq!("0100000000000010", out.as_binary());
- assert_eq!(16386, out.as_integer());
- }
- intersect_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.intersect(reversed);
- assert_eq!("00001000100000000000000100010000", out.as_binary());
- assert_eq!(142606608, out.as_integer());
- }
- intersect_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.intersect(reversed);
- assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", out.as_binary());
- assert_eq!(16866010309047355479, out.as_integer());
- }
- intersect_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.intersect(reversed);
- assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", out.as_binary());
- assert_eq!(138496081229041142656201681480886684694, out.as_integer());
- }
- // intersect_usize => {
- // let field = MyFieldUsize(USIZE);
- // }
- }
-
- // into diff
- tests! {
- into_diff_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_diff(reversed);
- assert_eq!("10100101", out.as_binary());
- assert_eq!(165, out.as_integer());
- }
- into_diff_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_diff(reversed);
- assert_eq!("1010101111010101", out.as_binary());
- assert_eq!(43989, out.as_integer());
- }
- into_diff_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_diff(reversed);
- assert_eq!("11110101000100111100100010101111", out.as_binary());
- assert_eq!(4111714479, out.as_integer());
- }
- into_diff_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_diff(reversed);
- assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", out.as_binary());
- assert_eq!(1495798268358312744, out.as_integer());
- }
- into_diff_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_diff(reversed);
- assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", out.as_binary());
- assert_eq!(193799958082971305581995159990093034377, out.as_integer());
- }
- // into_diff_usize => {
- // let field = MyFieldUsize(USIZE);
- // }
- }
-
- // into combined
- tests! {
- into_combined_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_combined(reversed);
- assert_eq!("11111111", out.as_binary());
- assert_eq!(255, out.as_integer());
- }
- into_combined_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_combined(reversed);
- assert_eq!("1110101111010111", out.as_binary());
- assert_eq!(60375, out.as_integer());
- }
- into_combined_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_combined(reversed);
- assert_eq!("11111101100100111100100110111111", out.as_binary());
- assert_eq!(4254321087, out.as_integer());
- }
- into_combined_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_combined(reversed);
- assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", out.as_binary());
- assert_eq!(18361808577405668223, out.as_integer());
- }
- into_combined_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_combined(reversed);
- assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", out.as_binary());
- assert_eq!(332296039312012448238196841470979719071, out.as_integer());
- }
- // into_combined_usize => {
- // let field = MyFieldUsize(USIZE);
- // }
- }
-
- // into intersection
- tests! {
- into_intersection_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_intersection(reversed);
- assert_eq!("01011010", out.as_binary());
- assert_eq!(90, out.as_integer());
- }
- into_intersection_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_intersection(reversed);
- assert_eq!("0100000000000010", out.as_binary());
- assert_eq!(16386, out.as_integer());
- }
- into_intersection_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_intersection(reversed);
- assert_eq!("00001000100000000000000100010000", out.as_binary());
- assert_eq!(142606608, out.as_integer());
- }
- into_intersection_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_intersection(reversed);
- assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", out.as_binary());
- assert_eq!(16866010309047355479, out.as_integer());
- }
- into_intersection_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field.into_intersection(reversed);
- assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", out.as_binary());
- assert_eq!(138496081229041142656201681480886684694, out.as_integer());
- }
- // into_intersection_usize => {
- // let field = MyFieldUsize(USIZE);
- // }
- }
-
- // field from flag
- tests! {
- field_from_flag_u8 => {
- for index in 0..u8::BITS {
- let flag = MyFlagsU8::from(index as u8);
- let field = MyFieldU8::from(flag);
- assert_eq!(MyFieldU8(0u8 | (1 << index)), field)
- }
- }
- field_from_flag_u16 => {
- for index in 0..u16::BITS {
- let flag = MyFlagsU16::from(index as u8);
- let field = MyFieldU16::from(flag);
- assert_eq!(MyFieldU16(0u16 | (1 << index)), field)
- }
- }
- field_from_flag_u32 => {
- for index in 0..u32::BITS {
- let flag = MyFlagsU32::from(index as u8);
- let field = MyFieldU32::from(flag);
- assert_eq!(MyFieldU32(0u32 | (1 << index)), field)
- }
- }
- field_from_flag_u64 => {
- for index in 0..u64::BITS {
- let flag = MyFlagsU64::from(index as u8);
- let field = MyFieldU64::from(flag);
- assert_eq!(MyFieldU64(0u64 | (1 << index)), field)
- }
- }
- field_from_flag_u128 => {
- for index in 0..u128::BITS {
- let flag = MyFlagsU128::from(index as u8);
- let field = MyFieldU128::from(flag);
- assert_eq!(MyFieldU128(0u128 | (1 << index)), field)
- }
- }
- field_from_flag_usize => {
- for index in 0..usize::BITS {
- let flag = MyFlagsUsize::from(index as u8);
- let field = MyFieldUsize::from(flag);
- assert_eq!(MyFieldUsize(0usize | (1 << index)), field)
- }
- }
- }
-
- // $name & $name
- tests! {
- bitwise_name_and_name_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field & reversed;
- assert_eq!("01011010", out.as_binary());
- assert_eq!(90, out.as_integer());
- }
- bitwise_name_and_name_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field & reversed;
- assert_eq!("0100000000000010", out.as_binary());
- assert_eq!(16386, out.as_integer());
- }
- bitwise_name_and_name_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field & reversed;
- assert_eq!("00001000100000000000000100010000", out.as_binary());
- assert_eq!(142606608, out.as_integer());
- }
- bitwise_name_and_name_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field & reversed;
- assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", out.as_binary());
- assert_eq!(16866010309047355479, out.as_integer());
- }
- bitwise_name_and_name_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field & reversed;
- assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", out.as_binary());
- assert_eq!(138496081229041142656201681480886684694, out.as_integer());
- }
- // bitwise_name_and_name_usize => {
- //
- // }
- }
-
- // $name | $name
- tests! {
- bitwise_name_or_name_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field | reversed;
- assert_eq!("11111111", out.as_binary());
- assert_eq!(255, out.as_integer());
- }
- bitwise_name_or_name_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field | reversed;
- assert_eq!("1110101111010111", out.as_binary());
- assert_eq!(60375, out.as_integer());
- }
- bitwise_name_or_name_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field | reversed;
- assert_eq!("11111101100100111100100110111111", out.as_binary());
- assert_eq!(4254321087, out.as_integer());
- }
- bitwise_name_or_name_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field | reversed;
- assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", out.as_binary());
- assert_eq!(18361808577405668223, out.as_integer());
- }
- bitwise_name_or_name_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field | reversed;
- assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", out.as_binary());
- assert_eq!(332296039312012448238196841470979719071, out.as_integer());
- }
- // bitwise_name_or_name_usize => {
- //
- // }
- }
-
- // $name ^ $name
- tests! {
- bitwise_name_xor_name_u8 => {
- let field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field ^ reversed;
- assert_eq!("10100101", out.as_binary());
- assert_eq!(165, out.as_integer());
- }
- bitwise_name_xor_name_u16 => {
- let field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field ^ reversed;
- assert_eq!("1010101111010101", out.as_binary());
- assert_eq!(43989, out.as_integer());
- }
- bitwise_name_xor_name_u32 => {
- let field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field ^ reversed;
- assert_eq!("11110101000100111100100010101111", out.as_binary());
- assert_eq!(4111714479, out.as_integer());
- }
- bitwise_name_xor_name_u64 => {
- let field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field ^ reversed;
- assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", out.as_binary());
- assert_eq!(1495798268358312744, out.as_integer());
- }
- bitwise_name_xor_name_u128 => {
- let field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- let out = field ^ reversed;
- assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", out.as_binary());
- assert_eq!(193799958082971305581995159990093034377, out.as_integer());
- }
- // bitwise_name_xor_name_usize => {
- //
- // }
- }
-
- // $name &= $name
- tests! {
- bitwise_name_and_assign_name_u8 => {
- let mut field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field &= reversed;
- assert_eq!("01011010", field.as_binary());
- assert_eq!(90, field.as_integer());
- }
- bitwise_name_and_assign_name_u16 => {
- let mut field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field &= reversed;
- assert_eq!("0100000000000010", field.as_binary());
- assert_eq!(16386, field.as_integer());
- }
- bitwise_name_and_assign_name_u32 => {
- let mut field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field &= reversed;
- assert_eq!("00001000100000000000000100010000", field.as_binary());
- assert_eq!(142606608, field.as_integer());
- }
- bitwise_name_and_assign_name_u64 => {
- let mut field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field &= reversed;
- assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", field.as_binary());
- assert_eq!(16866010309047355479, field.as_integer());
- }
- bitwise_name_and_assign_name_u128 => {
- let mut field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field &= reversed;
- assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", field.as_binary());
- assert_eq!(138496081229041142656201681480886684694, field.as_integer());
- }
- // bitwise_name_and_assign_name_usize => {
- //
- // }
- }
-
- // $name |= $name
- tests! {
- bitwise_name_or_assign_name_u8 => {
- let mut field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field |= reversed;
- assert_eq!("11111111", field.as_binary());
- assert_eq!(255, field.as_integer());
- }
- bitwise_name_or_assign_name_u16 => {
- let mut field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field |= reversed;
- assert_eq!("1110101111010111", field.as_binary());
- assert_eq!(60375, field.as_integer());
- }
- bitwise_name_or_assign_name_u32 => {
- let mut field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field |= reversed;
- assert_eq!("11111101100100111100100110111111", field.as_binary());
- assert_eq!(4254321087, field.as_integer());
- }
- bitwise_name_or_assign_name_u64 => {
- let mut field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field |= reversed;
- assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", field.as_binary());
- assert_eq!(18361808577405668223, field.as_integer());
- }
- bitwise_name_or_assign_name_u128 => {
- let mut field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field |= reversed;
- assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", field.as_binary());
- assert_eq!(332296039312012448238196841470979719071, field.as_integer());
- }
- // bitwise_name_or_assign_name_usize => {
- //
- // }
- }
-
- // $name ^= $name
- tests! {
- bitwise_name_xor_assign_name_u8 => {
- let mut field = MyFieldU8(U8);
- let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field ^= reversed;
- assert_eq!("10100101", field.as_binary());
- assert_eq!(165, field.as_integer());
- }
- bitwise_name_xor_assign_name_u16 => {
- let mut field = MyFieldU16(U16);
- let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field ^= reversed;
- assert_eq!("1010101111010101", field.as_binary());
- assert_eq!(43989, field.as_integer());
- }
- bitwise_name_xor_assign_name_u32 => {
- let mut field = MyFieldU32(U32);
- let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field ^= reversed;
- assert_eq!("11110101000100111100100010101111", field.as_binary());
- assert_eq!(4111714479, field.as_integer());
- }
- bitwise_name_xor_assign_name_u64 => {
- let mut field = MyFieldU64(U64);
- let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field ^= reversed;
- assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", field.as_binary());
- assert_eq!(1495798268358312744, field.as_integer());
- }
- bitwise_name_xor_assign_name_u128 => {
- let mut field = MyFieldU128(U128);
- let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
- field ^= reversed;
- assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", field.as_binary());
- assert_eq!(193799958082971305581995159990093034377, field.as_integer());
- }
- // bitwise_name_xor_assign_name_usize => {
- //
- // }
- }
-
- // $name & $flag
- tests! {
- bitwise_name_and_flag_u8 => {
- for index in 0..u8::BITS {
- let mask = MyFieldU8(u8::MAX) & MyFlagsU8::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
- }
- }
- bitwise_name_and_flag_u16 => {
- for index in 0..u16::BITS {
- let mask = MyFieldU16(u16::MAX) & MyFlagsU16::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
- }
- }
- bitwise_name_and_flag_u32 => {
- for index in 0..u32::BITS {
- let mask = MyFieldU32(u32::MAX) & MyFlagsU32::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
- }
- }
- bitwise_name_and_flag_u64 => {
- for index in 0..u64::BITS {
- let mask = MyFieldU64(u64::MAX) & MyFlagsU64::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ // diff
+ tests! {
+ diff_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.diff(reversed);
+ assert_eq!("10100101", out.as_binary());
+ assert_eq!(165, out.as_integer());
+ }
+ diff_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.diff(reversed);
+ assert_eq!("1010101111010101", out.as_binary());
+ assert_eq!(43989, out.as_integer());
+ }
+ diff_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.diff(reversed);
+ assert_eq!("11110101000100111100100010101111", out.as_binary());
+ assert_eq!(4111714479, out.as_integer());
+ }
+ diff_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.diff(reversed);
+ assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", out.as_binary());
+ assert_eq!(1495798268358312744, out.as_integer());
+ }
+ diff_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.diff(reversed);
+ assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", out.as_binary());
+ assert_eq!(193799958082971305581995159990093034377, out.as_integer());
+ }
+ // diff_usize => {
+ // let field = MyFieldUsize(USIZE);
+ // }
+ }
+
+ // combine
+ tests! {
+ combine_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.combine(reversed);
+ assert_eq!("11111111", out.as_binary());
+ assert_eq!(255, out.as_integer());
+ }
+ combine_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.combine(reversed);
+ assert_eq!("1110101111010111", out.as_binary());
+ assert_eq!(60375, out.as_integer());
+ }
+ combine_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.combine(reversed);
+ assert_eq!("11111101100100111100100110111111", out.as_binary());
+ assert_eq!(4254321087, out.as_integer());
+ }
+ combine_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.combine(reversed);
+ assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", out.as_binary());
+ assert_eq!(18361808577405668223, out.as_integer());
+ }
+ combine_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.combine(reversed);
+ assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", out.as_binary());
+ assert_eq!(332296039312012448238196841470979719071, out.as_integer());
+ }
+ // combine_usize => {
+ // let field = MyFieldUsize(USIZE);
+ // }
+ }
+
+ // intersect
+ tests! {
+ intersect_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.intersect(reversed);
+ assert_eq!("01011010", out.as_binary());
+ assert_eq!(90, out.as_integer());
+ }
+ intersect_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.intersect(reversed);
+ assert_eq!("0100000000000010", out.as_binary());
+ assert_eq!(16386, out.as_integer());
+ }
+ intersect_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.intersect(reversed);
+ assert_eq!("00001000100000000000000100010000", out.as_binary());
+ assert_eq!(142606608, out.as_integer());
+ }
+ intersect_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.intersect(reversed);
+ assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", out.as_binary());
+ assert_eq!(16866010309047355479, out.as_integer());
+ }
+ intersect_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.intersect(reversed);
+ assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", out.as_binary());
+ assert_eq!(138496081229041142656201681480886684694, out.as_integer());
+ }
+ // intersect_usize => {
+ // let field = MyFieldUsize(USIZE);
+ // }
+ }
+
+ // into diff
+ tests! {
+ into_diff_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_diff(reversed);
+ assert_eq!("10100101", out.as_binary());
+ assert_eq!(165, out.as_integer());
+ }
+ into_diff_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_diff(reversed);
+ assert_eq!("1010101111010101", out.as_binary());
+ assert_eq!(43989, out.as_integer());
+ }
+ into_diff_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_diff(reversed);
+ assert_eq!("11110101000100111100100010101111", out.as_binary());
+ assert_eq!(4111714479, out.as_integer());
+ }
+ into_diff_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_diff(reversed);
+ assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", out.as_binary());
+ assert_eq!(1495798268358312744, out.as_integer());
+ }
+ into_diff_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_diff(reversed);
+ assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", out.as_binary());
+ assert_eq!(193799958082971305581995159990093034377, out.as_integer());
+ }
+ // into_diff_usize => {
+ // let field = MyFieldUsize(USIZE);
+ // }
+ }
+
+ // into combined
+ tests! {
+ into_combined_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_combined(reversed);
+ assert_eq!("11111111", out.as_binary());
+ assert_eq!(255, out.as_integer());
+ }
+ into_combined_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_combined(reversed);
+ assert_eq!("1110101111010111", out.as_binary());
+ assert_eq!(60375, out.as_integer());
+ }
+ into_combined_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_combined(reversed);
+ assert_eq!("11111101100100111100100110111111", out.as_binary());
+ assert_eq!(4254321087, out.as_integer());
+ }
+ into_combined_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_combined(reversed);
+ assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", out.as_binary());
+ assert_eq!(18361808577405668223, out.as_integer());
+ }
+ into_combined_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_combined(reversed);
+ assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", out.as_binary());
+ assert_eq!(332296039312012448238196841470979719071, out.as_integer());
+ }
+ // into_combined_usize => {
+ // let field = MyFieldUsize(USIZE);
+ // }
+ }
+
+ // into intersection
+ tests! {
+ into_intersection_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_intersection(reversed);
+ assert_eq!("01011010", out.as_binary());
+ assert_eq!(90, out.as_integer());
+ }
+ into_intersection_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_intersection(reversed);
+ assert_eq!("0100000000000010", out.as_binary());
+ assert_eq!(16386, out.as_integer());
+ }
+ into_intersection_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_intersection(reversed);
+ assert_eq!("00001000100000000000000100010000", out.as_binary());
+ assert_eq!(142606608, out.as_integer());
+ }
+ into_intersection_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_intersection(reversed);
+ assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", out.as_binary());
+ assert_eq!(16866010309047355479, out.as_integer());
+ }
+ into_intersection_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field.into_intersection(reversed);
+ assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", out.as_binary());
+ assert_eq!(138496081229041142656201681480886684694, out.as_integer());
+ }
+ // into_intersection_usize => {
+ // let field = MyFieldUsize(USIZE);
+ // }
+ }
+
+ // field from flag
+ tests! {
+ field_from_flag_u8 => {
+ for index in 0..u8::BITS {
+ let flag = MyFlagsU8::from(index as u8);
+ let field = MyFieldU8::from(flag);
+ assert_eq!(MyFieldU8(0u8 | (1 << index)), field)
+ }
+ }
+ field_from_flag_u16 => {
+ for index in 0..u16::BITS {
+ let flag = MyFlagsU16::from(index as u8);
+ let field = MyFieldU16::from(flag);
+ assert_eq!(MyFieldU16(0u16 | (1 << index)), field)
+ }
+ }
+ field_from_flag_u32 => {
+ for index in 0..u32::BITS {
+ let flag = MyFlagsU32::from(index as u8);
+ let field = MyFieldU32::from(flag);
+ assert_eq!(MyFieldU32(0u32 | (1 << index)), field)
+ }
+ }
+ field_from_flag_u64 => {
+ for index in 0..u64::BITS {
+ let flag = MyFlagsU64::from(index as u8);
+ let field = MyFieldU64::from(flag);
+ assert_eq!(MyFieldU64(0u64 | (1 << index)), field)
+ }
+ }
+ field_from_flag_u128 => {
+ for index in 0..u128::BITS {
+ let flag = MyFlagsU128::from(index as u8);
+ let field = MyFieldU128::from(flag);
+ assert_eq!(MyFieldU128(0u128 | (1 << index)), field)
+ }
+ }
+ field_from_flag_usize => {
+ for index in 0..usize::BITS {
+ let flag = MyFlagsUsize::from(index as u8);
+ let field = MyFieldUsize::from(flag);
+ assert_eq!(MyFieldUsize(0usize | (1 << index)), field)
}
}
- bitwise_name_and_flag_u128 => {
- for index in 0..u128::BITS {
- let mask = MyFieldU128(u128::MAX) & MyFlagsU128::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
- }
- }
- // bitwise_name_and_flag_usize => {
- //
- // }
}
- // $name | $flag
- tests! {
- bitwise_name_or_flag_u8 => {
- for index in 0..u8::BITS {
- let mask = MyFieldU8(0) | MyFlagsU8::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ // $name & $name
+ tests! {
+ bitwise_name_and_name_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field & reversed;
+ assert_eq!("01011010", out.as_binary());
+ assert_eq!(90, out.as_integer());
+ }
+ bitwise_name_and_name_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field & reversed;
+ assert_eq!("0100000000000010", out.as_binary());
+ assert_eq!(16386, out.as_integer());
+ }
+ bitwise_name_and_name_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field & reversed;
+ assert_eq!("00001000100000000000000100010000", out.as_binary());
+ assert_eq!(142606608, out.as_integer());
+ }
+ bitwise_name_and_name_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field & reversed;
+ assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", out.as_binary());
+ assert_eq!(16866010309047355479, out.as_integer());
+ }
+ bitwise_name_and_name_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field & reversed;
+ assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", out.as_binary());
+ assert_eq!(138496081229041142656201681480886684694, out.as_integer());
+ }
+ // bitwise_name_and_name_usize => {
+ //
+ // }
+ }
+
+ // $name | $name
+ tests! {
+ bitwise_name_or_name_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field | reversed;
+ assert_eq!("11111111", out.as_binary());
+ assert_eq!(255, out.as_integer());
+ }
+ bitwise_name_or_name_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field | reversed;
+ assert_eq!("1110101111010111", out.as_binary());
+ assert_eq!(60375, out.as_integer());
+ }
+ bitwise_name_or_name_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field | reversed;
+ assert_eq!("11111101100100111100100110111111", out.as_binary());
+ assert_eq!(4254321087, out.as_integer());
+ }
+ bitwise_name_or_name_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field | reversed;
+ assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", out.as_binary());
+ assert_eq!(18361808577405668223, out.as_integer());
+ }
+ bitwise_name_or_name_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field | reversed;
+ assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", out.as_binary());
+ assert_eq!(332296039312012448238196841470979719071, out.as_integer());
+ }
+ // bitwise_name_or_name_usize => {
+ //
+ // }
+ }
+
+ // $name ^ $name
+ tests! {
+ bitwise_name_xor_name_u8 => {
+ let field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field ^ reversed;
+ assert_eq!("10100101", out.as_binary());
+ assert_eq!(165, out.as_integer());
+ }
+ bitwise_name_xor_name_u16 => {
+ let field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field ^ reversed;
+ assert_eq!("1010101111010101", out.as_binary());
+ assert_eq!(43989, out.as_integer());
+ }
+ bitwise_name_xor_name_u32 => {
+ let field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field ^ reversed;
+ assert_eq!("11110101000100111100100010101111", out.as_binary());
+ assert_eq!(4111714479, out.as_integer());
+ }
+ bitwise_name_xor_name_u64 => {
+ let field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field ^ reversed;
+ assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", out.as_binary());
+ assert_eq!(1495798268358312744, out.as_integer());
+ }
+ bitwise_name_xor_name_u128 => {
+ let field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ let out = field ^ reversed;
+ assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", out.as_binary());
+ assert_eq!(193799958082971305581995159990093034377, out.as_integer());
+ }
+ // bitwise_name_xor_name_usize => {
+ //
+ // }
+ }
+
+ // $name &= $name
+ tests! {
+ bitwise_name_and_assign_name_u8 => {
+ let mut field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field &= reversed;
+ assert_eq!("01011010", field.as_binary());
+ assert_eq!(90, field.as_integer());
+ }
+ bitwise_name_and_assign_name_u16 => {
+ let mut field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field &= reversed;
+ assert_eq!("0100000000000010", field.as_binary());
+ assert_eq!(16386, field.as_integer());
+ }
+ bitwise_name_and_assign_name_u32 => {
+ let mut field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field &= reversed;
+ assert_eq!("00001000100000000000000100010000", field.as_binary());
+ assert_eq!(142606608, field.as_integer());
+ }
+ bitwise_name_and_assign_name_u64 => {
+ let mut field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field &= reversed;
+ assert_eq!("1110101000010000000110110000010000100000110110000000100001010111", field.as_binary());
+ assert_eq!(16866010309047355479, field.as_integer());
+ }
+ bitwise_name_and_assign_name_u128 => {
+ let mut field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field &= reversed;
+ assert_eq!("01101000001100010110000000000000001000000110000000100001010111011011101010000100000001100000010000000000000001101000110000010110", field.as_binary());
+ assert_eq!(138496081229041142656201681480886684694, field.as_integer());
+ }
+ // bitwise_name_and_assign_name_usize => {
+ //
+ // }
+ }
+
+ // $name |= $name
+ tests! {
+ bitwise_name_or_assign_name_u8 => {
+ let mut field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field |= reversed;
+ assert_eq!("11111111", field.as_binary());
+ assert_eq!(255, field.as_integer());
+ }
+ bitwise_name_or_assign_name_u16 => {
+ let mut field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field |= reversed;
+ assert_eq!("1110101111010111", field.as_binary());
+ assert_eq!(60375, field.as_integer());
+ }
+ bitwise_name_or_assign_name_u32 => {
+ let mut field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field |= reversed;
+ assert_eq!("11111101100100111100100110111111", field.as_binary());
+ assert_eq!(4254321087, field.as_integer());
+ }
+ bitwise_name_or_assign_name_u64 => {
+ let mut field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field |= reversed;
+ assert_eq!("1111111011010010001111111001110110111001111111000100101101111111", field.as_binary());
+ assert_eq!(18361808577405668223, field.as_integer());
+ }
+ bitwise_name_or_assign_name_u128 => {
+ let mut field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field |= reversed;
+ assert_eq!("11111001111111011110001110100101111101111110111101101011111111111111111111010110111101111110111110100101110001111011111110011111", field.as_binary());
+ assert_eq!(332296039312012448238196841470979719071, field.as_integer());
+ }
+ // bitwise_name_or_assign_name_usize => {
+ //
+ // }
+ }
+
+ // $name ^= $name
+ tests! {
+ bitwise_name_xor_assign_name_u8 => {
+ let mut field = MyFieldU8(U8);
+ let reversed = MyFieldU8(u8::from_str_radix(B8.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field ^= reversed;
+ assert_eq!("10100101", field.as_binary());
+ assert_eq!(165, field.as_integer());
+ }
+ bitwise_name_xor_assign_name_u16 => {
+ let mut field = MyFieldU16(U16);
+ let reversed = MyFieldU16(u16::from_str_radix(B16.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field ^= reversed;
+ assert_eq!("1010101111010101", field.as_binary());
+ assert_eq!(43989, field.as_integer());
+ }
+ bitwise_name_xor_assign_name_u32 => {
+ let mut field = MyFieldU32(U32);
+ let reversed = MyFieldU32(u32::from_str_radix(B32.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field ^= reversed;
+ assert_eq!("11110101000100111100100010101111", field.as_binary());
+ assert_eq!(4111714479, field.as_integer());
+ }
+ bitwise_name_xor_assign_name_u64 => {
+ let mut field = MyFieldU64(U64);
+ let reversed = MyFieldU64(u64::from_str_radix(B64.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field ^= reversed;
+ assert_eq!("0001010011000010001001001001100110011001001001000100001100101000", field.as_binary());
+ assert_eq!(1495798268358312744, field.as_integer());
+ }
+ bitwise_name_xor_assign_name_u128 => {
+ let mut field = MyFieldU128(U128);
+ let reversed = MyFieldU128(u128::from_str_radix(B128.chars().rev().collect::<String>().as_str(), 2).unwrap());
+ field ^= reversed;
+ assert_eq!("10010001110011001000001110100101110101111000111101001010101000100100010101010010111100011110101110100101110000010011001110001001", field.as_binary());
+ assert_eq!(193799958082971305581995159990093034377, field.as_integer());
+ }
+ // bitwise_name_xor_assign_name_usize => {
+ //
+ // }
+ }
+
+ // $name & $flag
+ tests! {
+ bitwise_name_and_flag_u8 => {
+ for index in 0..u8::BITS {
+ let mask = MyFieldU8(u8::MAX) & MyFlagsU8::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ }
+ }
+ bitwise_name_and_flag_u16 => {
+ for index in 0..u16::BITS {
+ let mask = MyFieldU16(u16::MAX) & MyFlagsU16::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ }
+ }
+ bitwise_name_and_flag_u32 => {
+ for index in 0..u32::BITS {
+ let mask = MyFieldU32(u32::MAX) & MyFlagsU32::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ }
+ }
+ bitwise_name_and_flag_u64 => {
+ for index in 0..u64::BITS {
+ let mask = MyFieldU64(u64::MAX) & MyFlagsU64::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ }
+ }
+ bitwise_name_and_flag_u128 => {
+ for index in 0..u128::BITS {
+ let mask = MyFieldU128(u128::MAX) & MyFlagsU128::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ }
+ }
+ // bitwise_name_and_flag_usize => {
+ //
+ // }
+ }
+
+ // $name | $flag
+ tests! {
+ bitwise_name_or_flag_u8 => {
+ for index in 0..u8::BITS {
+ let mask = MyFieldU8(0) | MyFlagsU8::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_flag_u16 => {
- for index in 0..u16::BITS {
- let mask = MyFieldU16(0) | MyFlagsU16::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_flag_u16 => {
+ for index in 0..u16::BITS {
+ let mask = MyFieldU16(0) | MyFlagsU16::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_flag_u32 => {
- for index in 0..u32::BITS {
- let mask = MyFieldU32(0) | MyFlagsU32::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_flag_u32 => {
+ for index in 0..u32::BITS {
+ let mask = MyFieldU32(0) | MyFlagsU32::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_flag_u64 => {
- for index in 0..u64::BITS {
- let mask = MyFieldU64(0) | MyFlagsU64::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_flag_u64 => {
+ for index in 0..u64::BITS {
+ let mask = MyFieldU64(0) | MyFlagsU64::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_flag_u128 => {
- for index in 0..u128::BITS {
- let mask = MyFieldU128(0) | MyFlagsU128::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_flag_u128 => {
+ for index in 0..u128::BITS {
+ let mask = MyFieldU128(0) | MyFlagsU128::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- // bitwise_name_or_flag_usize => {
- //
- // }
- }
+ // bitwise_name_or_flag_usize => {
+ //
+ // }
+ }
- // $name ^ $flag
- tests! {
- bitwise_name_xor_flag_u8 => {
- for index in 0..u8::BITS {
- let mask = MyFieldU8(0) ^ MyFlagsU8::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ // $name ^ $flag
+ tests! {
+ bitwise_name_xor_flag_u8 => {
+ for index in 0..u8::BITS {
+ let mask = MyFieldU8(0) ^ MyFlagsU8::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_flag_u16 => {
- for index in 0..u16::BITS {
- let mask = MyFieldU16(0) ^ MyFlagsU16::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_flag_u16 => {
+ for index in 0..u16::BITS {
+ let mask = MyFieldU16(0) ^ MyFlagsU16::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_flag_u32 => {
- for index in 0..u32::BITS {
- let mask = MyFieldU32(0) ^ MyFlagsU32::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_flag_u32 => {
+ for index in 0..u32::BITS {
+ let mask = MyFieldU32(0) ^ MyFlagsU32::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_flag_u64 => {
- for index in 0..u64::BITS {
- let mask = MyFieldU64(0) ^ MyFlagsU64::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_flag_u64 => {
+ for index in 0..u64::BITS {
+ let mask = MyFieldU64(0) ^ MyFlagsU64::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_flag_u128 => {
- for index in 0..u128::BITS {
- let mask = MyFieldU128(0) ^ MyFlagsU128::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_flag_u128 => {
+ for index in 0..u128::BITS {
+ let mask = MyFieldU128(0) ^ MyFlagsU128::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- // bitwise_name_xor_flag_usize => {
- //
- // }
- }
+ // bitwise_name_xor_flag_usize => {
+ //
+ // }
+ }
- // $name &= $flag
- tests! {
- bitwise_name_and_assign_flag_u8 => {
- for index in 0..u8::BITS {
- let mut mask = MyFieldU8(u8::MAX);
- mask &= MyFlagsU8::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ // $name &= $flag
+ tests! {
+ bitwise_name_and_assign_flag_u8 => {
+ for index in 0..u8::BITS {
+ let mut mask = MyFieldU8(u8::MAX);
+ mask &= MyFlagsU8::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_and_assign_flag_u16 => {
- for index in 0..u16::BITS {
- let mut mask = MyFieldU16(u16::MAX);
- mask &= MyFlagsU16::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ bitwise_name_and_assign_flag_u16 => {
+ for index in 0..u16::BITS {
+ let mut mask = MyFieldU16(u16::MAX);
+ mask &= MyFlagsU16::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_and_assign_flag_u32 => {
- for index in 0..u32::BITS {
- let mut mask = MyFieldU32(u32::MAX);
- mask &= MyFlagsU32::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ bitwise_name_and_assign_flag_u32 => {
+ for index in 0..u32::BITS {
+ let mut mask = MyFieldU32(u32::MAX);
+ mask &= MyFlagsU32::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_and_assign_flag_u64 => {
- for index in 0..u64::BITS {
- let mut mask = MyFieldU64(u64::MAX);
- mask &= MyFlagsU64::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ bitwise_name_and_assign_flag_u64 => {
+ for index in 0..u64::BITS {
+ let mut mask = MyFieldU64(u64::MAX);
+ mask &= MyFlagsU64::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_and_assign_flag_u128 => {
- for index in 0..u128::BITS {
- let mut mask = MyFieldU128(u128::MAX);
- mask &= MyFlagsU128::from(index as u8);
- assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
+ bitwise_name_and_assign_flag_u128 => {
+ for index in 0..u128::BITS {
+ let mut mask = MyFieldU128(u128::MAX);
+ mask &= MyFlagsU128::from(index as u8);
+ assert_eq!(0 | !(1 << (index as u8) ), mask.as_integer());
}
}
- // bitwise_name_and_assign_flag_usize => {
- //
- // }
- }
+ // bitwise_name_and_assign_flag_usize => {
+ //
+ // }
+ }
- // $name |= $flag
- tests! {
- bitwise_name_or_assign_flag_u8 => {
- for index in 0..u8::BITS {
- let mut mask = MyFieldU8(0);
- mask |= MyFlagsU8::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ // $name |= $flag
+ tests! {
+ bitwise_name_or_assign_flag_u8 => {
+ for index in 0..u8::BITS {
+ let mut mask = MyFieldU8(0);
+ mask |= MyFlagsU8::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_assign_flag_u16 => {
- for index in 0..u16::BITS {
- let mut mask = MyFieldU16(0);
- mask |= MyFlagsU16::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_assign_flag_u16 => {
+ for index in 0..u16::BITS {
+ let mut mask = MyFieldU16(0);
+ mask |= MyFlagsU16::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_assign_flag_u32 => {
- for index in 0..u32::BITS {
- let mut mask = MyFieldU32(0);
- mask |= MyFlagsU32::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_assign_flag_u32 => {
+ for index in 0..u32::BITS {
+ let mut mask = MyFieldU32(0);
+ mask |= MyFlagsU32::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_assign_flag_u64 => {
- for index in 0..u64::BITS {
- let mut mask = MyFieldU64(0);
- mask |= MyFlagsU64::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_assign_flag_u64 => {
+ for index in 0..u64::BITS {
+ let mut mask = MyFieldU64(0);
+ mask |= MyFlagsU64::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_or_assign_flag_u128 => {
- for index in 0..u128::BITS {
- let mut mask = MyFieldU128(0);
- mask |= MyFlagsU128::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_or_assign_flag_u128 => {
+ for index in 0..u128::BITS {
+ let mut mask = MyFieldU128(0);
+ mask |= MyFlagsU128::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- // bitwise_name_or_assign_flag_usize => {
- //
- // }
- }
+ // bitwise_name_or_assign_flag_usize => {
+ //
+ // }
+ }
- // $name ^= $flag
- tests! {
- bitwise_name_xor_assign_flag_u8 => {
- for index in 0..u8::BITS {
- let mut mask = MyFieldU8(0);
- mask ^= MyFlagsU8::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ // $name ^= $flag
+ tests! {
+ bitwise_name_xor_assign_flag_u8 => {
+ for index in 0..u8::BITS {
+ let mut mask = MyFieldU8(0);
+ mask ^= MyFlagsU8::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_assign_flag_u16 => {
- for index in 0..u16::BITS {
- let mut mask = MyFieldU16(0);
- mask ^= MyFlagsU16::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_assign_flag_u16 => {
+ for index in 0..u16::BITS {
+ let mut mask = MyFieldU16(0);
+ mask ^= MyFlagsU16::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_assign_flag_u32 => {
- for index in 0..u32::BITS {
- let mut mask = MyFieldU32(0);
- mask ^= MyFlagsU32::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_assign_flag_u32 => {
+ for index in 0..u32::BITS {
+ let mut mask = MyFieldU32(0);
+ mask ^= MyFlagsU32::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_assign_flag_u64 => {
- for index in 0..u64::BITS {
- let mut mask = MyFieldU64(0);
- mask ^= MyFlagsU64::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_assign_flag_u64 => {
+ for index in 0..u64::BITS {
+ let mut mask = MyFieldU64(0);
+ mask ^= MyFlagsU64::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- bitwise_name_xor_assign_flag_u128 => {
- for index in 0..u128::BITS {
- let mut mask = MyFieldU128(0);
- mask ^= MyFlagsU128::from(index as u8);
- assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
+ bitwise_name_xor_assign_flag_u128 => {
+ for index in 0..u128::BITS {
+ let mut mask = MyFieldU128(0);
+ mask ^= MyFlagsU128::from(index as u8);
+ assert_eq!(0 | (1 << (index as u8) ), mask.as_integer());
}
}
- // bitwise_name_xor_assign_flag_usize => {
- //
- // }
- }
+ // bitwise_name_xor_assign_flag_usize => {
+ //
+ // }
+ }
- // $flag & $flag
- tests! {
- bitwise_flag_and_flag_u8 => {
- for index_a in 0..u8::BITS {
- let a = MyFlagsU8::from(index_a as u8);
- for index_b in 0..u8::BITS {
- let b = MyFlagsU8::from(index_b as u8);
- assert_eq!(MyFieldU8(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
+ // $flag & $flag
+ tests! {
+ bitwise_flag_and_flag_u8 => {
+ for index_a in 0..u8::BITS {
+ let a = MyFlagsU8::from(index_a as u8);
+ for index_b in 0..u8::BITS {
+ let b = MyFlagsU8::from(index_b as u8);
+ assert_eq!(MyFieldU8(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
}
}
}
- bitwise_flag_and_flag_u16 => {
- for index_a in 0..u16::BITS {
- let a = MyFlagsU16::from(index_a as u8);
- for index_b in 0..u16::BITS {
- let b = MyFlagsU16::from(index_b as u8);
- assert_eq!(MyFieldU16(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
+ bitwise_flag_and_flag_u16 => {
+ for index_a in 0..u16::BITS {
+ let a = MyFlagsU16::from(index_a as u8);
+ for index_b in 0..u16::BITS {
+ let b = MyFlagsU16::from(index_b as u8);
+ assert_eq!(MyFieldU16(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
}
}
}
- bitwise_flag_and_flag_u32 => {
- for index_a in 0..u32::BITS {
- let a = MyFlagsU32::from(index_a as u8);
- for index_b in 0..u32::BITS {
- let b = MyFlagsU32::from(index_b as u8);
- assert_eq!(MyFieldU32(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
+ bitwise_flag_and_flag_u32 => {
+ for index_a in 0..u32::BITS {
+ let a = MyFlagsU32::from(index_a as u8);
+ for index_b in 0..u32::BITS {
+ let b = MyFlagsU32::from(index_b as u8);
+ assert_eq!(MyFieldU32(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
}
}
}
- bitwise_flag_and_flag_u64 => {
- for index_a in 0..u64::BITS {
- let a = MyFlagsU64::from(index_a as u8);
- for index_b in 0..u64::BITS {
- let b = MyFlagsU64::from(index_b as u8);
- assert_eq!(MyFieldU64(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
+ bitwise_flag_and_flag_u64 => {
+ for index_a in 0..u64::BITS {
+ let a = MyFlagsU64::from(index_a as u8);
+ for index_b in 0..u64::BITS {
+ let b = MyFlagsU64::from(index_b as u8);
+ assert_eq!(MyFieldU64(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
}
}
}
- bitwise_flag_and_flag_u128 => {
- for index_a in 0..u128::BITS {
- let a = MyFlagsU128::from(index_a as u8);
- for index_b in 0..u128::BITS {
- let b = MyFlagsU128::from(index_b as u8);
- assert_eq!(MyFieldU128(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
+ bitwise_flag_and_flag_u128 => {
+ for index_a in 0..u128::BITS {
+ let a = MyFlagsU128::from(index_a as u8);
+ for index_b in 0..u128::BITS {
+ let b = MyFlagsU128::from(index_b as u8);
+ assert_eq!(MyFieldU128(0 & 1 << index_a as u8 & 1 << index_b as u8), a & b);
}
}
}
- // bitwise_flag_and_flag_usize => {
- //
- // }
- }
+ // bitwise_flag_and_flag_usize => {
+ //
+ // }
+ }
- // $flag | $flag
- tests! {
- bitwise_flag_or_flag_u8 => {
- for index_a in 0..u8::BITS {
- let a = MyFlagsU8::from(index_a as u8);
- for index_b in 0..u8::BITS {
- let b = MyFlagsU8::from(index_b as u8);
- assert_eq!(MyFieldU8(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
+ // $flag | $flag
+ tests! {
+ bitwise_flag_or_flag_u8 => {
+ for index_a in 0..u8::BITS {
+ let a = MyFlagsU8::from(index_a as u8);
+ for index_b in 0..u8::BITS {
+ let b = MyFlagsU8::from(index_b as u8);
+ assert_eq!(MyFieldU8(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
}
}
}
- bitwise_flag_or_flag_u16 => {
- for index_a in 0..u16::BITS {
- let a = MyFlagsU16::from(index_a as u8);
- for index_b in 0..u16::BITS {
- let b = MyFlagsU16::from(index_b as u8);
- assert_eq!(MyFieldU16(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
+ bitwise_flag_or_flag_u16 => {
+ for index_a in 0..u16::BITS {
+ let a = MyFlagsU16::from(index_a as u8);
+ for index_b in 0..u16::BITS {
+ let b = MyFlagsU16::from(index_b as u8);
+ assert_eq!(MyFieldU16(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
}
}
}
- bitwise_flag_or_flag_u32 => {
- for index_a in 0..u32::BITS {
- let a = MyFlagsU32::from(index_a as u8);
- for index_b in 0..u32::BITS {
- let b = MyFlagsU32::from(index_b as u8);
- assert_eq!(MyFieldU32(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
+ bitwise_flag_or_flag_u32 => {
+ for index_a in 0..u32::BITS {
+ let a = MyFlagsU32::from(index_a as u8);
+ for index_b in 0..u32::BITS {
+ let b = MyFlagsU32::from(index_b as u8);
+ assert_eq!(MyFieldU32(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
}
}
}
- bitwise_flag_or_flag_u64 => {
- for index_a in 0..u64::BITS {
- let a = MyFlagsU64::from(index_a as u8);
- for index_b in 0..u64::BITS {
- let b = MyFlagsU64::from(index_b as u8);
- assert_eq!(MyFieldU64(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
+ bitwise_flag_or_flag_u64 => {
+ for index_a in 0..u64::BITS {
+ let a = MyFlagsU64::from(index_a as u8);
+ for index_b in 0..u64::BITS {
+ let b = MyFlagsU64::from(index_b as u8);
+ assert_eq!(MyFieldU64(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
}
}
}
- bitwise_flag_or_flag_u128 => {
- for index_a in 0..u128::BITS {
- let a = MyFlagsU128::from(index_a as u8);
- for index_b in 0..u128::BITS {
- let b = MyFlagsU128::from(index_b as u8);
- assert_eq!(MyFieldU128(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
+ bitwise_flag_or_flag_u128 => {
+ for index_a in 0..u128::BITS {
+ let a = MyFlagsU128::from(index_a as u8);
+ for index_b in 0..u128::BITS {
+ let b = MyFlagsU128::from(index_b as u8);
+ assert_eq!(MyFieldU128(0 | 1 << index_a as u8 | 1 << index_b as u8), a | b);
}
}
}
- // bitwise_flag_or_flag_usize => {
- //
- // }
- }
+ // bitwise_flag_or_flag_usize => {
+ //
+ // }
+ }
- // $flag ^ $flag
- tests! {
- bitwise_flag_xor_flag_u8 => {
- for index_a in 0..u8::BITS {
- let a = MyFlagsU8::from(index_a as u8);
- for index_b in 0..u8::BITS {
- let b = MyFlagsU8::from(index_b as u8);
- assert_eq!(MyFieldU8(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
+ // $flag ^ $flag
+ tests! {
+ bitwise_flag_xor_flag_u8 => {
+ for index_a in 0..u8::BITS {
+ let a = MyFlagsU8::from(index_a as u8);
+ for index_b in 0..u8::BITS {
+ let b = MyFlagsU8::from(index_b as u8);
+ assert_eq!(MyFieldU8(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
}
}
}
- bitwise_flag_xor_flag_u16 => {
- for index_a in 0..u16::BITS {
- let a = MyFlagsU16::from(index_a as u8);
- for index_b in 0..u16::BITS {
- let b = MyFlagsU16::from(index_b as u8);
- assert_eq!(MyFieldU16(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
+ bitwise_flag_xor_flag_u16 => {
+ for index_a in 0..u16::BITS {
+ let a = MyFlagsU16::from(index_a as u8);
+ for index_b in 0..u16::BITS {
+ let b = MyFlagsU16::from(index_b as u8);
+ assert_eq!(MyFieldU16(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
}
}
}
- bitwise_flag_xor_flag_u32 => {
- for index_a in 0..u32::BITS {
- let a = MyFlagsU32::from(index_a as u8);
- for index_b in 0..u32::BITS {
- let b = MyFlagsU32::from(index_b as u8);
- assert_eq!(MyFieldU32(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
+ bitwise_flag_xor_flag_u32 => {
+ for index_a in 0..u32::BITS {
+ let a = MyFlagsU32::from(index_a as u8);
+ for index_b in 0..u32::BITS {
+ let b = MyFlagsU32::from(index_b as u8);
+ assert_eq!(MyFieldU32(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
}
}
}
- bitwise_flag_xor_flag_u64 => {
- for index_a in 0..u64::BITS {
- let a = MyFlagsU64::from(index_a as u8);
- for index_b in 0..u64::BITS {
- let b = MyFlagsU64::from(index_b as u8);
- assert_eq!(MyFieldU64(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
+ bitwise_flag_xor_flag_u64 => {
+ for index_a in 0..u64::BITS {
+ let a = MyFlagsU64::from(index_a as u8);
+ for index_b in 0..u64::BITS {
+ let b = MyFlagsU64::from(index_b as u8);
+ assert_eq!(MyFieldU64(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
}
}
}
- bitwise_flag_xor_flag_u128 => {
- for index_a in 0..u128::BITS {
- let a = MyFlagsU128::from(index_a as u8);
- for index_b in 0..u128::BITS {
- let b = MyFlagsU128::from(index_b as u8);
- assert_eq!(MyFieldU128(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
+ bitwise_flag_xor_flag_u128 => {
+ for index_a in 0..u128::BITS {
+ let a = MyFlagsU128::from(index_a as u8);
+ for index_b in 0..u128::BITS {
+ let b = MyFlagsU128::from(index_b as u8);
+ assert_eq!(MyFieldU128(0 ^ 1 << index_a as u8 ^ 1 << index_b as u8), a ^ b);
}
}
}
- // bitwise_flag_xor_flag_usize => {
- //
- // }
- }
+ // bitwise_flag_xor_flag_usize => {
+ //
+ // }
+ }
- // flag from u8
- tests! {
- flag_from_u8_u8 => {
- for index in 0..u8::BITS {
- let _ = MyFlagsU8::from(index as u8);
+ // flag from u8
+ tests! {
+ flag_from_u8_u8 => {
+ for index in 0..u8::BITS {
+ let _ = MyFlagsU8::from(index as u8);
}
}
- flag_from_u8_u16 => {
- for index in 0..u16::BITS {
- let _ = MyFlagsU16::from(index as u8);
+ flag_from_u8_u16 => {
+ for index in 0..u16::BITS {
+ let _ = MyFlagsU16::from(index as u8);
}
}
- flag_from_u8_u32 => {
- for index in 0..u32::BITS {
- let _ = MyFlagsU32::from(index as u8);
+ flag_from_u8_u32 => {
+ for index in 0..u32::BITS {
+ let _ = MyFlagsU32::from(index as u8);
}
}
- flag_from_u8_u64 => {
- for index in 0..u64::BITS {
- let _ = MyFlagsU64::from(index as u8);
+ flag_from_u8_u64 => {
+ for index in 0..u64::BITS {
+ let _ = MyFlagsU64::from(index as u8);
}
}
- flag_from_u8_u128 => {
- for index in 0..u128::BITS {
- let _ = MyFlagsU128::from(index as u8);
+ flag_from_u8_u128 => {
+ for index in 0..u128::BITS {
+ let _ = MyFlagsU128::from(index as u8);
}
}
- flag_from_u8_usize => {
- for index in 0..usize::BITS {
- let _ = MyFlagsUsize::from(index as u8);
+ flag_from_u8_usize => {
+ for index in 0..usize::BITS {
+ let _ = MyFlagsUsize::from(index as u8);
}
}
}
- // u8 from flag
- tests! {
- u8_from_flag_u8 => {
- for index in 0..u8::BITS {
- assert_eq!(MyFlagsU8::from(index as u8) as u8, index as u8)
+ // u8 from flag
+ tests! {
+ u8_from_flag_u8 => {
+ for index in 0..u8::BITS {
+ assert_eq!(MyFlagsU8::from(index as u8) as u8, index as u8)
}
}
- u8_from_flag_u16 => {
- for index in 0..u16::BITS {
- assert_eq!(MyFlagsU16::from(index as u8) as u8, index as u8)
+ u8_from_flag_u16 => {
+ for index in 0..u16::BITS {
+ assert_eq!(MyFlagsU16::from(index as u8) as u8, index as u8)
}
}
- u8_from_flag_u32 => {
- for index in 0..u32::BITS {
- assert_eq!(MyFlagsU32::from(index as u8) as u8, index as u8)
+ u8_from_flag_u32 => {
+ for index in 0..u32::BITS {
+ assert_eq!(MyFlagsU32::from(index as u8) as u8, index as u8)
}
}
- u8_from_flag_u64 => {
- for index in 0..u64::BITS {
- assert_eq!(MyFlagsU64::from(index as u8) as u8, index as u8)
+ u8_from_flag_u64 => {
+ for index in 0..u64::BITS {
+ assert_eq!(MyFlagsU64::from(index as u8) as u8, index as u8)
}
}
- u8_from_flag_u128 => {
- for index in 0..u128::BITS {
- assert_eq!(MyFlagsU128::from(index as u8) as u8, index as u8)
+ u8_from_flag_u128 => {
+ for index in 0..u128::BITS {
+ assert_eq!(MyFlagsU128::from(index as u8) as u8, index as u8)
}
}
- u8_from_flag_usize => {
- for index in 0..usize::BITS {
- assert_eq!(MyFlagsUsize::from(index as u8) as u8, index as u8)
+ u8_from_flag_usize => {
+ for index in 0..usize::BITS {
+ assert_eq!(MyFlagsUsize::from(index as u8) as u8, index as u8)
}
}
}
}
-// -------------------------------------------------------------------------------------------------
-
-"+searchState.loadingText+"
";searchState.showResults(search)},};const toggleAllDocsId="toggle-all-docs";let savedHash="";function handleHashes(ev){if(ev!==null&&searchState.isDisplayed()&&ev.newURL){switchDisplayedElement(null);const hash=ev.newURL.slice(ev.newURL.indexOf("#")+1);if(browserSupportsHistoryApi()){history.replaceState(null,"",getNakedUrl()+window.location.search+"#"+hash)}const elem=document.getElementById(hash);if(elem){elem.scrollIntoView()}}const pageId=window.location.hash.replace(/^#/,"");if(savedHash!==pageId){savedHash=pageId;if(pageId!==""){expandSection(pageId)}}}function onHashChange(ev){hideSidebar();handleHashes(ev)}function openParentDetails(elem){while(elem){if(elem.tagName==="DETAILS"){elem.open=true}elem=elem.parentNode}}function expandSection(id){openParentDetails(document.getElementById(id))}function handleEscape(ev){searchState.clearInputTimeout();searchState.hideResults();ev.preventDefault();searchState.defocus();window.hideAllModals(true)}function handleShortcut(ev){const disableShortcuts=getSettingValue("disable-shortcuts")==="true";if(ev.ctrlKey||ev.altKey||ev.metaKey||disableShortcuts){return}if(document.activeElement.tagName==="INPUT"&&document.activeElement.type!=="checkbox"&&document.activeElement.type!=="radio"){switch(getVirtualKey(ev)){case"Escape":handleEscape(ev);break}}else{switch(getVirtualKey(ev)){case"Escape":handleEscape(ev);break;case"s":case"S":ev.preventDefault();searchState.focus();break;case"+":ev.preventDefault();expandAllDocs();break;case"-":ev.preventDefault();collapseAllDocs();break;case"?":showHelp();break;default:break}}}document.addEventListener("keypress",handleShortcut);document.addEventListener("keydown",handleShortcut);function addSidebarItems(){if(!window.SIDEBAR_ITEMS){return}const sidebar=document.getElementsByClassName("sidebar-elems")[0];function block(shortty,id,longty){const filtered=window.SIDEBAR_ITEMS[shortty];if(!filtered){return}const h3=document.createElement("h3");h3.innerHTML=`${longty}`;const ul=document.createElement("ul");ul.className="block "+shortty;for(const name of filtered){let path;if(shortty==="mod"){path=name+"/index.html"}else{path=shortty+"."+name+".html"}const current_page=document.location.href.split("/").pop();const link=document.createElement("a");link.href=path;if(path===current_page){link.className="current"}link.textContent=name;const li=document.createElement("li");li.appendChild(link);ul.appendChild(li)}sidebar.appendChild(h3);sidebar.appendChild(ul)}if(sidebar){block("primitive","primitives","Primitive Types");block("mod","modules","Modules");block("macro","macros","Macros");block("struct","structs","Structs");block("enum","enums","Enums");block("union","unions","Unions");block("constant","constants","Constants");block("static","static","Statics");block("trait","traits","Traits");block("fn","functions","Functions");block("type","types","Type Definitions");block("foreigntype","foreign-types","Foreign Types");block("keyword","keywords","Keywords");block("traitalias","trait-aliases","Trait Aliases")}}window.register_implementors=imp=>{const implementors=document.getElementById("implementors-list");const synthetic_implementors=document.getElementById("synthetic-implementors-list");const inlined_types=new Set();const TEXT_IDX=0;const SYNTHETIC_IDX=1;const TYPES_IDX=2;if(synthetic_implementors){onEachLazy(synthetic_implementors.getElementsByClassName("impl"),el=>{const aliases=el.getAttribute("data-aliases");if(!aliases){return}aliases.split(",").forEach(alias=>{inlined_types.add(alias)})})}let currentNbImpls=implementors.getElementsByClassName("impl").length;const traitName=document.querySelector(".main-heading h1 > .trait").textContent;const baseIdName="impl-"+traitName+"-";const libs=Object.getOwnPropertyNames(imp);const script=document.querySelector("script[data-ignore-extern-crates]");const ignoreExternCrates=new Set((script?script.getAttribute("data-ignore-extern-crates"):"").split(","));for(const lib of libs){if(lib===window.currentCrate||ignoreExternCrates.has(lib)){continue}const structs=imp[lib];struct_loop:for(const struct of structs){const list=struct[SYNTHETIC_IDX]?synthetic_implementors:implementors;if(struct[SYNTHETIC_IDX]){for(const struct_type of struct[TYPES_IDX]){if(inlined_types.has(struct_type)){continue struct_loop}inlined_types.add(struct_type)}}const code=document.createElement("h3");code.innerHTML=struct[TEXT_IDX];addClass(code,"code-header");onEachLazy(code.getElementsByTagName("a"),elem=>{const href=elem.getAttribute("href");if(href&&!/^(?:[a-z+]+:)?\/\//.test(href)){elem.setAttribute("href",window.rootPath+href)}});const currentId=baseIdName+currentNbImpls;const anchor=document.createElement("a");anchor.href="#"+currentId;addClass(anchor,"anchor");const display=document.createElement("div");display.id=currentId;addClass(display,"impl");display.appendChild(anchor);display.appendChild(code);list.appendChild(display);currentNbImpls+=1}}};if(window.pending_implementors){window.register_implementors(window.pending_implementors)}function addSidebarCrates(){if(!window.ALL_CRATES){return}const sidebarElems=document.getElementsByClassName("sidebar-elems")[0];if(!sidebarElems){return}const h3=document.createElement("h3");h3.innerHTML="Crates";const ul=document.createElement("ul");ul.className="block crate";for(const crate of window.ALL_CRATES){const link=document.createElement("a");link.href=window.rootPath+crate+"/index.html";if(window.rootPath!=="./"&&crate===window.currentCrate){link.className="current"}link.textContent=crate;const li=document.createElement("li");li.appendChild(link);ul.appendChild(li)}sidebarElems.appendChild(h3);sidebarElems.appendChild(ul)}function expandAllDocs(){const innerToggle=document.getElementById(toggleAllDocsId);removeClass(innerToggle,"will-expand");onEachLazy(document.getElementsByClassName("toggle"),e=>{if(!hasClass(e,"type-contents-toggle")&&!hasClass(e,"more-examples-toggle")){e.open=true}});innerToggle.title="collapse all docs";innerToggle.children[0].innerText="\u2212"}function collapseAllDocs(){const innerToggle=document.getElementById(toggleAllDocsId);addClass(innerToggle,"will-expand");onEachLazy(document.getElementsByClassName("toggle"),e=>{if(e.parentNode.id!=="implementations-list"||(!hasClass(e,"implementors-toggle")&&!hasClass(e,"type-contents-toggle"))){e.open=false}});innerToggle.title="expand all docs";innerToggle.children[0].innerText="+"}function toggleAllDocs(){const innerToggle=document.getElementById(toggleAllDocsId);if(!innerToggle){return}if(hasClass(innerToggle,"will-expand")){expandAllDocs()}else{collapseAllDocs()}}(function(){const toggles=document.getElementById(toggleAllDocsId);if(toggles){toggles.onclick=toggleAllDocs}const hideMethodDocs=getSettingValue("auto-hide-method-docs")==="true";const hideImplementations=getSettingValue("auto-hide-trait-implementations")==="true";const hideLargeItemContents=getSettingValue("auto-hide-large-items")!=="false";function setImplementorsTogglesOpen(id,open){const list=document.getElementById(id);if(list!==null){onEachLazy(list.getElementsByClassName("implementors-toggle"),e=>{e.open=open})}}if(hideImplementations){setImplementorsTogglesOpen("trait-implementations-list",false);setImplementorsTogglesOpen("blanket-implementations-list",false)}onEachLazy(document.getElementsByClassName("toggle"),e=>{if(!hideLargeItemContents&&hasClass(e,"type-contents-toggle")){e.open=true}if(hideMethodDocs&&hasClass(e,"method-toggle")){e.open=false}})}());window.rustdoc_add_line_numbers_to_examples=()=>{onEachLazy(document.getElementsByClassName("rust-example-rendered"),x=>{const parent=x.parentNode;const line_numbers=parent.querySelectorAll(".example-line-numbers");if(line_numbers.length>0){return}const count=x.textContent.split("\n").length;const elems=[];for(let i=0;i"+window.NOTABLE_TRAITS[notable_ty]+"
"}else{if(e.getAttribute("title")!==null){e.setAttribute("data-title",e.getAttribute("title"));e.removeAttribute("title")}if(e.getAttribute("data-title")!==null){const titleContent=document.createElement("div");titleContent.className="content";titleContent.appendChild(document.createTextNode(e.getAttribute("data-title")));wrapper.appendChild(titleContent)}}wrapper.className="tooltip popover";const focusCatcher=document.createElement("div");focusCatcher.setAttribute("tabindex","0");focusCatcher.onfocus=hideTooltip;wrapper.appendChild(focusCatcher);const pos=e.getBoundingClientRect();wrapper.style.top=(pos.top+window.scrollY+pos.height)+"px";wrapper.style.left=0;wrapper.style.right="auto";wrapper.style.visibility="hidden";const body=document.getElementsByTagName("body")[0];body.appendChild(wrapper);const wrapperPos=wrapper.getBoundingClientRect();const finalPos=pos.left+window.scrollX-wrapperPos.width+24;if(finalPos>0){wrapper.style.left=finalPos+"px"}else{wrapper.style.setProperty("--popover-arrow-offset",(wrapperPos.right-pos.right+4)+"px")}wrapper.style.visibility="";window.CURRENT_TOOLTIP_ELEMENT=wrapper;window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE=e;clearTooltipHoverTimeout(window.CURRENT_TOOLTIP_ELEMENT);wrapper.onpointerenter=function(ev){if(ev.pointerType!=="mouse"){return}clearTooltipHoverTimeout(e)};wrapper.onpointerleave=function(ev){if(ev.pointerType!=="mouse"){return}if(!e.TOOLTIP_FORCE_VISIBLE&&!elemIsInParent(ev.relatedTarget,e)){setTooltipHoverTimeout(e,false);addClass(wrapper,"fade-out")}}}function setTooltipHoverTimeout(element,show){clearTooltipHoverTimeout(element);if(!show&&!window.CURRENT_TOOLTIP_ELEMENT){return}if(show&&window.CURRENT_TOOLTIP_ELEMENT){return}if(window.CURRENT_TOOLTIP_ELEMENT&&window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE!==element){return}element.TOOLTIP_HOVER_TIMEOUT=setTimeout(()=>{if(show){showTooltip(element)}else if(!element.TOOLTIP_FORCE_VISIBLE){hideTooltip(false)}},show?window.RUSTDOC_TOOLTIP_HOVER_MS:window.RUSTDOC_TOOLTIP_HOVER_EXIT_MS)}function clearTooltipHoverTimeout(element){if(element.TOOLTIP_HOVER_TIMEOUT!==undefined){removeClass(window.CURRENT_TOOLTIP_ELEMENT,"fade-out");clearTimeout(element.TOOLTIP_HOVER_TIMEOUT);delete element.TOOLTIP_HOVER_TIMEOUT}}function tooltipBlurHandler(event){if(window.CURRENT_TOOLTIP_ELEMENT&&!elemIsInParent(document.activeElement,window.CURRENT_TOOLTIP_ELEMENT)&&!elemIsInParent(event.relatedTarget,window.CURRENT_TOOLTIP_ELEMENT)&&!elemIsInParent(document.activeElement,window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE)&&!elemIsInParent(event.relatedTarget,window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE)){setTimeout(()=>hideTooltip(false),0)}}function hideTooltip(focus){if(window.CURRENT_TOOLTIP_ELEMENT){if(window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE.TOOLTIP_FORCE_VISIBLE){if(focus){window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE.focus()}window.CURRENT_TOOLTIP_ELEMENT.TOOLTIP_BASE.TOOLTIP_FORCE_VISIBLE=false}const body=document.getElementsByTagName("body")[0];body.removeChild(window.CURRENT_TOOLTIP_ELEMENT);clearTooltipHoverTimeout(window.CURRENT_TOOLTIP_ELEMENT);window.CURRENT_TOOLTIP_ELEMENT=null}}onEachLazy(document.getElementsByClassName("tooltip"),e=>{e.onclick=function(){this.TOOLTIP_FORCE_VISIBLE=this.TOOLTIP_FORCE_VISIBLE?false:true;if(window.CURRENT_TOOLTIP_ELEMENT&&!this.TOOLTIP_FORCE_VISIBLE){hideTooltip(true)}else{showTooltip(this);window.CURRENT_TOOLTIP_ELEMENT.setAttribute("tabindex","0");window.CURRENT_TOOLTIP_ELEMENT.focus();window.CURRENT_TOOLTIP_ELEMENT.onblur=tooltipBlurHandler}return false};e.onpointerenter=function(ev){if(ev.pointerType!=="mouse"){return}setTooltipHoverTimeout(this,true)};e.onpointermove=function(ev){if(ev.pointerType!=="mouse"){return}setTooltipHoverTimeout(this,true)};e.onpointerleave=function(ev){if(ev.pointerType!=="mouse"){return}if(!this.TOOLTIP_FORCE_VISIBLE&&!elemIsInParent(ev.relatedTarget,window.CURRENT_TOOLTIP_ELEMENT)){setTooltipHoverTimeout(e,false);addClass(window.CURRENT_TOOLTIP_ELEMENT,"fade-out")}}});const sidebar_menu_toggle=document.getElementsByClassName("sidebar-menu-toggle")[0];if(sidebar_menu_toggle){sidebar_menu_toggle.addEventListener("click",()=>{const sidebar=document.getElementsByClassName("sidebar")[0];if(!hasClass(sidebar,"shown")){showSidebar()}else{hideSidebar()}})}function helpBlurHandler(event){blurHandler(event,getHelpButton(),window.hidePopoverMenus)}function buildHelpMenu(){const book_info=document.createElement("span");const channel=getVar("channel");book_info.className="top";book_info.innerHTML=`You can find more information in \
+the rustdoc book.`;const shortcuts=[["?","Show this help dialog"],["S","Focus the search field"],["↑","Move up in search results"],["↓","Move down in search results"],["← / →","Switch result tab (when results focused)"],["⏎","Go to active search result"],["+","Expand all sections"],["-","Collapse all sections"],].map(x=>"Keyboard Shortcuts
- "+shortcuts+"
fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ -> vec or String, enum:Cow -> bool)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for functions that accept or return \
+ slices and \
+ arrays by writing \
+ square brackets (e.g., -> [u8] or [] -> Option)","Look for items inside another one by searching for a path: vec::Vec",].map(x=>""+x+"
").join("");const div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="Search Tricks
"+infos;const rustdoc_version=document.createElement("span");rustdoc_version.className="bottom";const rustdoc_version_code=document.createElement("code");rustdoc_version_code.innerText="rustdoc "+getVar("rustdoc-version");rustdoc_version.appendChild(rustdoc_version_code);const container=document.createElement("div");if(!isHelpPage){container.className="popover"}container.id="help";container.style.display="none";const side_by_side=document.createElement("div");side_by_side.className="side-by-side";side_by_side.appendChild(div_shortcuts);side_by_side.appendChild(div_infos);container.appendChild(book_info);container.appendChild(side_by_side);container.appendChild(rustdoc_version);if(isHelpPage){const help_section=document.createElement("section");help_section.appendChild(container);document.getElementById("main-content").appendChild(help_section);container.style.display="block"}else{const help_button=getHelpButton();help_button.appendChild(container);container.onblur=helpBlurHandler;help_button.onblur=helpBlurHandler;help_button.children[0].onblur=helpBlurHandler}return container}window.hideAllModals=function(switchFocus){hideSidebar();window.hidePopoverMenus();hideTooltip(switchFocus)};window.hidePopoverMenus=function(){onEachLazy(document.querySelectorAll(".search-form .popover"),elem=>{elem.style.display="none"})};function getHelpMenu(buildNeeded){let menu=getHelpButton().querySelector(".popover");if(!menu&&buildNeeded){menu=buildHelpMenu()}return menu}function showHelp(){getHelpButton().querySelector("a").focus();const menu=getHelpMenu(true);if(menu.style.display==="none"){window.hideAllModals();menu.style.display=""}}if(isHelpPage){showHelp();document.querySelector(`#${HELP_BUTTON_ID} > a`).addEventListener("click",event=>{const target=event.target;if(target.tagName!=="A"||target.parentElement.id!==HELP_BUTTON_ID||event.ctrlKey||event.altKey||event.metaKey){return}event.preventDefault()})}else{document.querySelector(`#${HELP_BUTTON_ID} > a`).addEventListener("click",event=>{const target=event.target;if(target.tagName!=="A"||target.parentElement.id!==HELP_BUTTON_ID||event.ctrlKey||event.altKey||event.metaKey){return}event.preventDefault();const menu=getHelpMenu(true);const shouldShowHelp=menu.style.display==="none";if(shouldShowHelp){showHelp()}else{window.hidePopoverMenus()}})}setMobileTopbar();addSidebarItems();addSidebarCrates();onHashChange(null);window.addEventListener("hashchange",onHashChange);searchState.setup()}());(function(){let reset_button_timeout=null;const but=document.getElementById("copy-path");if(!but){return}but.onclick=()=>{const parent=but.parentElement;const path=[];onEach(parent.childNodes,child=>{if(child.tagName==="A"){path.push(child.textContent)}});const el=document.createElement("textarea");el.value=path.join("::");el.setAttribute("readonly","");el.style.position="absolute";el.style.left="-9999px";document.body.appendChild(el);el.select();document.execCommand("copy");document.body.removeChild(el);but.children[0].style.display="none";let tmp;if(but.childNodes.length<2){tmp=document.createTextNode("✓");but.appendChild(tmp)}else{onEachLazy(but.childNodes,e=>{if(e.nodeType===Node.TEXT_NODE){tmp=e;return true}});tmp.textContent="✓"}if(reset_button_timeout!==null){window.clearTimeout(reset_button_timeout)}function reset_button(){tmp.textContent="";reset_button_timeout=null;but.children[0].style.display=""}reset_button_timeout=window.setTimeout(reset_button,1000)}}()) \ No newline at end of file diff --git a/docs/doc/normalize.css b/docs/doc/static.files/normalize-76eba96aa4d2e634.css similarity index 100% rename from docs/doc/normalize.css rename to docs/doc/static.files/normalize-76eba96aa4d2e634.css diff --git a/docs/doc/static.files/noscript-13285aec31fa243e.css b/docs/doc/static.files/noscript-13285aec31fa243e.css new file mode 100644 index 0000000..c32e0cb --- /dev/null +++ b/docs/doc/static.files/noscript-13285aec31fa243e.css @@ -0,0 +1 @@ + #main-content .attributes{margin-left:0 !important;}#copy-path{display:none;}nav.sub{display:none;}.source .sidebar{display:none;}.notable-traits{display:none;} \ No newline at end of file diff --git a/docs/doc/rust-logo.svg b/docs/doc/static.files/rust-logo-151179464ae7ed46.svg similarity index 100% rename from docs/doc/rust-logo.svg rename to docs/doc/static.files/rust-logo-151179464ae7ed46.svg diff --git a/docs/doc/static.files/rustdoc-9bb858ba049f1f21.css b/docs/doc/static.files/rustdoc-9bb858ba049f1f21.css new file mode 100644 index 0000000..73eacd8 --- /dev/null +++ b/docs/doc/static.files/rustdoc-9bb858ba049f1f21.css @@ -0,0 +1,8 @@ + :root{--nav-sub-mobile-padding:8px;--search-typename-width:6.75rem;}@font-face {font-family:'Fira Sans';font-style:normal;font-weight:400;src:local('Fira Sans'),url("FiraSans-Regular-018c141bf0843ffd.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Fira Sans';font-style:normal;font-weight:500;src:local('Fira Sans Medium'),url("FiraSans-Medium-8f9a781e4970d388.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Source Serif 4';font-style:normal;font-weight:400;src:local('Source Serif 4'),url("SourceSerif4-Regular-46f98efaafac5295.ttf.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Source Serif 4';font-style:italic;font-weight:400;src:local('Source Serif 4 Italic'),url("SourceSerif4-It-acdfaf1a8af734b1.ttf.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Source Serif 4';font-style:normal;font-weight:700;src:local('Source Serif 4 Bold'),url("SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Source Code Pro';font-style:normal;font-weight:400;src:url("SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Source Code Pro';font-style:italic;font-weight:400;src:url("SourceCodePro-It-1cc31594bf4f1f79.ttf.woff2") format("woff2");font-display:swap;}@font-face {font-family:'Source Code Pro';font-style:normal;font-weight:600;src:url("SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2") format("woff2");font-display:swap;}@font-face {font-family:'NanumBarunGothic';src:url("NanumBarunGothic-0f09457c7a19b7c6.ttf.woff2") format("woff2");font-display:swap;unicode-range:U+AC00-D7AF,U+1100-11FF,U+3130-318F,U+A960-A97F,U+D7B0-D7FF;}*{box-sizing:border-box;}body{font:1rem/1.5 "Source Serif 4",NanumBarunGothic,serif;margin:0;position:relative;overflow-wrap:break-word;overflow-wrap:anywhere;font-feature-settings:"kern","liga";background-color:var(--main-background-color);color:var(--main-color);}h1{font-size:1.5rem;}h2{font-size:1.375rem;}h3{font-size:1.25rem;}h1,h2,h3,h4,h5,h6{font-weight:500;}h1,h2,h3,h4{margin:25px 0 15px 0;padding-bottom:6px;}.docblock h3,.docblock h4,h5,h6{margin:15px 0 5px 0;}.docblock>h2:first-child,.docblock>h3:first-child,.docblock>h4:first-child,.docblock>h5:first-child,.docblock>h6:first-child{margin-top:0;}.main-heading h1{margin:0;padding:0;flex-grow:1;overflow-wrap:break-word;overflow-wrap:anywhere;}.main-heading{display:flex;flex-wrap:wrap;padding-bottom:6px;margin-bottom:15px;}.content h2,.top-doc .docblock>h3,.top-doc .docblock>h4{border-bottom:1px solid var(--headings-border-bottom-color);}h1,h2{line-height:1.25;padding-top:3px;padding-bottom:9px;}h3.code-header{font-size:1.125rem;}h4.code-header{font-size:1rem;}.code-header{font-weight:600;margin:0;padding:0;white-space:pre-wrap;}#crate-search,h1,h2,h3,h4,h5,h6,.sidebar,.mobile-topbar,.search-input,.search-results .result-name,.item-name>a,.out-of-band,span.since,a.srclink,#help-button>a,summary.hideme,.scraped-example-list,ul.all-items{font-family:"Fira Sans",Arial,NanumBarunGothic,sans-serif;}#toggle-all-docs,a.anchor,.small-section-header a,#source-sidebar a,.rust a,.sidebar h2 a,.sidebar h3 a,.mobile-topbar h2 a,h1 a,.search-results a,.stab,.result-name i{color:var(--main-color);}span.enum,a.enum,span.struct,a.struct,span.union,a.union,span.primitive,a.primitive,span.type,a.type,span.foreigntype,a.foreigntype{color:var(--type-link-color);}span.trait,a.trait,span.traitalias,a.traitalias{color:var(--trait-link-color);}span.associatedtype,a.associatedtype,span.constant,a.constant,span.static,a.static{color:var(--assoc-item-link-color);}span.fn,a.fn,span.method,a.method,span.tymethod,a.tymethod{color:var(--function-link-color);}span.attr,a.attr,span.derive,a.derive,span.macro,a.macro{color:var(--macro-link-color);}span.mod,a.mod{color:var(--mod-link-color);}span.keyword,a.keyword{color:var(--keyword-link-color);}a{color:var(--link-color);text-decoration:none;}ol,ul{padding-left:24px;}ul ul,ol ul,ul ol,ol ol{margin-bottom:.625em;}p{margin:0 0 .75em 0;}p:last-child{margin:0;}button{padding:1px 6px;cursor:pointer;}button#toggle-all-docs{padding:0;background:none;border:none;-webkit-appearance:none;opacity:1;}.rustdoc{display:flex;flex-direction:row;flex-wrap:nowrap;}main{position:relative;flex-grow:1;padding:10px 15px 40px 45px;min-width:0;}.source main{padding:15px;}.width-limiter{max-width:960px;margin-right:auto;}details:not(.toggle) summary{margin-bottom:.6em;}code,pre,a.test-arrow,.code-header{font-family:"Source Code Pro",monospace;}.docblock code,.docblock-short code{border-radius:3px;padding:0 0.125em;}.docblock pre code,.docblock-short pre code{padding:0;}pre{padding:14px;line-height:1.5;}pre.item-decl{overflow-x:auto;}.item-decl .type-contents-toggle{contain:initial;}.source .content pre{padding:20px;}.rustdoc.source .example-wrap pre.src-line-numbers{padding:20px 0 20px 4px;}img{max-width:100%;}.sub-logo-container,.logo-container{line-height:0;display:block;}.sub-logo-container{margin-right:32px;}.sub-logo-container>img{height:60px;width:60px;object-fit:contain;}.rust-logo{filter:var(--rust-logo-filter);}.sidebar{font-size:0.875rem;flex:0 0 200px;overflow-y:scroll;overscroll-behavior:contain;position:sticky;height:100vh;top:0;left:0;}.rustdoc.source .sidebar{flex-basis:50px;border-right:1px solid;overflow-x:hidden;overflow-y:hidden;z-index:1;}.sidebar,.mobile-topbar,.sidebar-menu-toggle,#src-sidebar-toggle,#source-sidebar{background-color:var(--sidebar-background-color);}#src-sidebar-toggle>button:hover,#src-sidebar-toggle>button:focus{background-color:var(--sidebar-background-color-hover);}.source .sidebar>*:not(#src-sidebar-toggle){visibility:hidden;}.source-sidebar-expanded .source .sidebar{overflow-y:auto;flex-basis:300px;}.source-sidebar-expanded .source .sidebar>*:not(#src-sidebar-toggle){visibility:visible;}#all-types{margin-top:1em;}*{scrollbar-width:initial;scrollbar-color:var(--scrollbar-color);}.sidebar{scrollbar-width:thin;scrollbar-color:var(--scrollbar-color);}::-webkit-scrollbar{width:12px;}.sidebar::-webkit-scrollbar{width:8px;}::-webkit-scrollbar-track{-webkit-box-shadow:inset 0;background-color:var(--scrollbar-track-background-color);}.sidebar::-webkit-scrollbar-track{background-color:var(--scrollbar-track-background-color);}::-webkit-scrollbar-thumb,.sidebar::-webkit-scrollbar-thumb{background-color:var(--scrollbar-thumb-background-color);}.hidden{display:none !important;}.sidebar .logo-container{margin-top:10px;margin-bottom:10px;text-align:center;}.version{overflow-wrap:break-word;}.logo-container>img{height:100px;width:100px;}ul.block,.block li{padding:0;margin:0;list-style:none;}.sidebar-elems a,.sidebar>h2 a{display:block;padding:0.25rem;margin-left:-0.25rem;}.sidebar h2{overflow-wrap:anywhere;padding:0;margin:0.7rem 0;}.sidebar h3{font-size:1.125rem;padding:0;margin:0;}.sidebar-elems,.sidebar>h2{padding-left:24px;}.sidebar a{color:var(--sidebar-link-color);}.sidebar .current,.sidebar a:hover:not(.logo-container){background-color:var(--sidebar-current-link-background-color);}.sidebar-elems .block{margin-bottom:2em;}.sidebar-elems .block li a{white-space:nowrap;text-overflow:ellipsis;overflow:hidden;}.mobile-topbar{display:none;}.rustdoc .example-wrap{display:flex;position:relative;margin-bottom:10px;}.rustdoc .example-wrap:last-child{margin-bottom:0px;}.rustdoc .example-wrap pre{margin:0;flex-grow:1;}.rustdoc:not(.source) .example-wrap pre{overflow:auto hidden;}.rustdoc .example-wrap pre.example-line-numbers,.rustdoc .example-wrap pre.src-line-numbers{flex-grow:0;min-width:fit-content;overflow:initial;text-align:right;-webkit-user-select:none;user-select:none;padding:14px 8px;color:var(--src-line-numbers-span-color);}.rustdoc .example-wrap pre.src-line-numbers{padding:14px 0;}.src-line-numbers a,.src-line-numbers span{color:var(--src-line-numbers-span-color);padding:0 8px;}.src-line-numbers :target{background-color:transparent;border-right:none;padding:0 8px;}.src-line-numbers .line-highlighted{background-color:var(--src-line-number-highlighted-background-color);}.search-loading{text-align:center;}.docblock-short{overflow-wrap:break-word;overflow-wrap:anywhere;}.docblock :not(pre)>code,.docblock-short code{white-space:pre-wrap;}.top-doc .docblock h2{font-size:1.375rem;}.top-doc .docblock h3{font-size:1.25rem;}.top-doc .docblock h4,.top-doc .docblock h5{font-size:1.125rem;}.top-doc .docblock h6{font-size:1rem;}.docblock h5{font-size:1rem;}.docblock h6{font-size:0.875rem;}.docblock{margin-left:24px;position:relative;}.docblock>:not(.more-examples-toggle):not(.example-wrap){max-width:100%;overflow-x:auto;}.out-of-band{flex-grow:0;font-size:1.125rem;}.docblock code,.docblock-short code,pre,.rustdoc.source .example-wrap{background-color:var(--code-block-background-color);}#main-content{position:relative;}.docblock table{margin:.5em 0;border-collapse:collapse;}.docblock table td,.docblock table th{padding:.5em;border:1px solid var(--border-color);}.docblock table tbody tr:nth-child(2n){background:var(--table-alt-row-background-color);}.method .where,.fn .where,.where.fmt-newline{display:block;white-space:pre-wrap;font-size:0.875rem;}.item-info{display:block;margin-left:24px;}.item-info code{font-size:0.875rem;}#main-content>.item-info{margin-left:0;}nav.sub{flex-grow:1;flex-flow:row nowrap;margin:4px 0 25px 0;display:flex;align-items:center;}.search-form{position:relative;display:flex;height:34px;flex-grow:1;}.source nav.sub{margin:0 0 15px 0;}.small-section-header{display:block;position:relative;}.small-section-header:hover>.anchor,.impl:hover>.anchor,.trait-impl:hover>.anchor,.variant:hover>.anchor{display:initial;}.anchor{display:none;position:absolute;left:-0.5em;background:none !important;}.anchor.field{left:-5px;}.small-section-header>.anchor{left:-15px;padding-right:8px;}h2.small-section-header>.anchor{padding-right:6px;}.main-heading a:hover,.example-wrap .rust a:hover,.all-items a:hover,.docblock a:not(.test-arrow):not(.scrape-help):not(.tooltip):hover,.docblock-short a:not(.test-arrow):not(.scrape-help):not(.tooltip):hover,.item-info a{text-decoration:underline;}.crate.block a.current{font-weight:500;}table,.item-table{overflow-wrap:break-word;}.item-table{display:table;padding:0;margin:0;}.item-table>li{display:table-row;}.item-table>li>div{display:table-cell;}.item-table>li>.item-name{padding-right:1.25rem;}.search-results-title{margin-top:0;white-space:nowrap;display:flex;align-items:baseline;}#crate-search-div{position:relative;min-width:5em;}#crate-search{min-width:115px;padding:0 23px 0 4px;max-width:100%;text-overflow:ellipsis;border:1px solid var(--border-color);border-radius:4px;outline:none;cursor:pointer;-moz-appearance:none;-webkit-appearance:none;text-indent:0.01px;background-color:var(--main-background-color);color:inherit;line-height:1.5;font-weight:500;}#crate-search:hover,#crate-search:focus{border-color:var(--crate-search-hover-border);}@-moz-document url-prefix(){#crate-search{padding-left:0px;padding-right:19px;}}#crate-search-div::after{pointer-events:none;width:100%;height:100%;position:absolute;top:0;left:0;content:"";background-repeat:no-repeat;background-size:20px;background-position:calc(100% - 2px) 56%;background-image:url('data:image/svg+xml,');filter:var(--crate-search-div-filter);}#crate-search-div:hover::after,#crate-search-div:focus-within::after{filter:var(--crate-search-div-hover-filter);}#crate-search>option{font-size:1rem;}.search-input{-webkit-appearance:none;outline:none;border:1px solid var(--border-color);border-radius:2px;padding:8px;font-size:1rem;flex-grow:1;background-color:var(--button-background-color);color:var(--search-color);}.search-input:focus{border-color:var(--search-input-focused-border-color);}.search-results{display:none;}.search-results.active{display:block;}.search-results>a{display:flex;margin-left:2px;margin-right:2px;border-bottom:1px solid var(--search-result-border-color);gap:1em;}.search-results>a>div.desc{white-space:nowrap;text-overflow:ellipsis;overflow:hidden;flex:2;}.search-results a:hover,.search-results a:focus{background-color:var(--search-result-link-focus-background-color);}.search-results .result-name{display:flex;align-items:center;justify-content:start;flex:3;}.search-results .result-name span.alias{color:var(--search-results-alias-color);}.search-results .result-name .grey{color:var(--search-results-grey-color);}.search-results .result-name .typename{color:var(--search-results-grey-color);font-size:0.875rem;width:var(--search-typename-width);}.search-results .result-name .path{word-break:break-all;max-width:calc(100% - var(--search-typename-width));display:inline-block;}.popover{position:absolute;top:100%;right:0;z-index:2;margin-top:7px;border-radius:3px;border:1px solid var(--border-color);background-color:var(--main-background-color);color:var(--main-color);--popover-arrow-offset:11px;}.popover::before{content:'';position:absolute;right:var(--popover-arrow-offset);border:solid var(--border-color);border-width:1px 1px 0 0;background-color:var(--main-background-color);padding:4px;transform:rotate(-45deg);top:-5px;}#help.popover{max-width:600px;--popover-arrow-offset:48px;}#help dt{float:left;clear:left;margin-right:0.5rem;}#help span.top,#help span.bottom{text-align:center;display:block;font-size:1.125rem;}#help span.top{margin:10px 0;border-bottom:1px solid var(--border-color);padding-bottom:4px;margin-bottom:6px;}#help span.bottom{clear:both;border-top:1px solid var(--border-color);}.side-by-side>div{width:50%;float:left;padding:0 20px 20px 17px;}.item-info .stab{min-height:36px;display:flex;padding:3px;margin-bottom:5px;align-items:center;vertical-align:text-bottom;}.item-name .stab{margin-left:0.3125em;}.stab{padding:0 2px;font-size:0.875rem;font-weight:normal;color:var(--main-color);background-color:var(--stab-background-color);width:fit-content;white-space:pre-wrap;border-radius:3px;display:inline;}.stab.portability>code{background:none;color:var(--stab-code-color);}.stab .emoji{font-size:1.25rem;margin-right:0.3rem;}.emoji{text-shadow:1px 0 0 black,-1px 0 0 black,0 1px 0 black,0 -1px 0 black;}.since{font-weight:normal;font-size:initial;}.rightside{padding-left:12px;float:right;}.rightside:not(a),.out-of-band{color:var(--right-side-color);}pre.rust{tab-size:4;-moz-tab-size:4;}pre.rust .kw{color:var(--code-highlight-kw-color);}pre.rust .kw-2{color:var(--code-highlight-kw-2-color);}pre.rust .lifetime{color:var(--code-highlight-lifetime-color);}pre.rust .prelude-ty{color:var(--code-highlight-prelude-color);}pre.rust .prelude-val{color:var(--code-highlight-prelude-val-color);}pre.rust .string{color:var(--code-highlight-string-color);}pre.rust .number{color:var(--code-highlight-number-color);}pre.rust .bool-val{color:var(--code-highlight-literal-color);}pre.rust .self{color:var(--code-highlight-self-color);}pre.rust .attr{color:var(--code-highlight-attribute-color);}pre.rust .macro,pre.rust .macro-nonterminal{color:var(--code-highlight-macro-color);}pre.rust .question-mark{font-weight:bold;color:var(--code-highlight-question-mark-color);}pre.rust .comment{color:var(--code-highlight-comment-color);}pre.rust .doccomment{color:var(--code-highlight-doc-comment-color);}.rustdoc.source .example-wrap pre.rust a{background:var(--codeblock-link-background);}.example-wrap.compile_fail,.example-wrap.should_panic{border-left:2px solid var(--codeblock-error-color);}.ignore.example-wrap{border-left:2px solid var(--codeblock-ignore-color);}.example-wrap.compile_fail:hover,.example-wrap.should_panic:hover{border-left:2px solid var(--codeblock-error-hover-color);}.example-wrap.ignore:hover{border-left:2px solid var(--codeblock-ignore-hover-color);}.example-wrap.compile_fail .tooltip,.example-wrap.should_panic .tooltip{color:var(--codeblock-error-color);}.example-wrap.ignore .tooltip{color:var(--codeblock-ignore-color);}.example-wrap.compile_fail:hover .tooltip,.example-wrap.should_panic:hover .tooltip{color:var(--codeblock-error-hover-color);}.example-wrap.ignore:hover .tooltip{color:var(--codeblock-ignore-hover-color);}.example-wrap .tooltip{position:absolute;display:block;left:-25px;top:5px;margin:0;line-height:1;}.example-wrap.compile_fail .tooltip,.example-wrap.should_panic .tooltip,.example-wrap.ignore .tooltip{font-weight:bold;font-size:1.25rem;}a.test-arrow{visibility:hidden;position:absolute;padding:5px 10px 5px 10px;border-radius:5px;font-size:1.375rem;top:5px;right:5px;z-index:1;color:var(--test-arrow-color);background-color:var(--test-arrow-background-color);}a.test-arrow:hover{color:var(--test-arrow-hover-color);background-color:var(--test-arrow-hover-background-color);}.example-wrap:hover .test-arrow{visibility:visible;}.code-attribute{font-weight:300;color:var(--code-attribute-color);}.item-spacer{width:100%;height:12px;display:block;}.out-of-band>span.since{font-size:1.25rem;}.sub-variant h4{font-size:1rem;font-weight:400;margin-top:0;margin-bottom:0;}.sub-variant{margin-left:24px;margin-bottom:40px;}.sub-variant>.sub-variant-field{margin-left:24px;}:target{padding-right:3px;background-color:var(--target-background-color);border-right:3px solid var(--target-border-color);}.code-header a.tooltip{color:inherit;margin-right:15px;position:relative;}.code-header a.tooltip:hover{color:var(--link-color);}a.tooltip:hover::after{position:absolute;top:calc(100% - 10px);left:-15px;right:-15px;height:20px;content:"\00a0";}.fade-out{opacity:0;transition:opacity 0.45s cubic-bezier(0,0,0.1,1.0);}.popover.tooltip .content{margin:0.25em 0.5em;}.popover.tooltip .content pre,.popover.tooltip .content code{background:transparent;margin:0;padding:0;font-size:1.25rem;white-space:pre-wrap;}.popover.tooltip .content>h3:first-child{margin:0 0 5px 0;}.search-failed{text-align:center;margin-top:20px;display:none;}.search-failed.active{display:block;}.search-failed>ul{text-align:left;max-width:570px;margin-left:auto;margin-right:auto;}#search-tabs{display:flex;flex-direction:row;gap:1px;margin-bottom:4px;}#search-tabs button{text-align:center;font-size:1.125rem;border:0;border-top:2px solid;flex:1;line-height:1.5;color:inherit;}#search-tabs button:not(.selected){background-color:var(--search-tab-button-not-selected-background);border-top-color:var(--search-tab-button-not-selected-border-top-color);}#search-tabs button:hover,#search-tabs button.selected{background-color:var(--search-tab-button-selected-background);border-top-color:var(--search-tab-button-selected-border-top-color);}#search-tabs .count{font-size:1rem;color:var(--search-tab-title-count-color);}#search .error code{border-radius:3px;background-color:var(--search-error-code-background-color);}.search-corrections{font-weight:normal;}#src-sidebar-toggle{position:sticky;top:0;left:0;font-size:1.25rem;border-bottom:1px solid;display:flex;height:40px;justify-content:stretch;align-items:stretch;z-index:10;}#source-sidebar{width:100%;overflow:auto;}#source-sidebar>.title{font-size:1.5rem;text-align:center;border-bottom:1px solid var(--border-color);margin-bottom:6px;}#source-sidebar div.files>a:hover,details.dir-entry summary:hover,#source-sidebar div.files>a:focus,details.dir-entry summary:focus{background-color:var(--source-sidebar-background-hover);}#source-sidebar div.files>a.selected{background-color:var(--source-sidebar-background-selected);}#src-sidebar-toggle>button{font-size:inherit;font-weight:bold;background:none;color:inherit;text-align:center;border:none;outline:none;flex:1 1;-webkit-appearance:none;opacity:1;}#settings-menu,#help-button{margin-left:4px;display:flex;}#settings-menu>a,#help-button>a{display:flex;align-items:center;justify-content:center;background-color:var(--button-background-color);border:1px solid var(--border-color);border-radius:2px;color:var(--settings-button-color);font-size:20px;width:33px;}#settings-menu>a:hover,#settings-menu>a:focus,#help-button>a:hover,#help-button>a:focus{border-color:var(--settings-button-border-focus);}#copy-path{color:var(--copy-path-button-color);background:var(--main-background-color);height:34px;margin-left:10px;padding:0;padding-left:2px;border:0;width:33px;}#copy-path>img{filter:var(--copy-path-img-filter);}#copy-path:hover>img{filter:var(--copy-path-img-hover-filter);}@keyframes rotating{from{transform:rotate(0deg);}to{transform:rotate(360deg);}}#settings-menu.rotate>a img{animation:rotating 2s linear infinite;}kbd{display:inline-block;padding:3px 5px;font:15px monospace;line-height:10px;vertical-align:middle;border:solid 1px var(--border-color);border-radius:3px;color:var(--kbd-color);background-color:var(--kbd-background);box-shadow:inset 0 -1px 0 var(--kbd-box-shadow-color);}ul.all-items>li{list-style:none;}details.dir-entry{padding-left:4px;}details.dir-entry>summary{margin:0 0 0 -4px;padding:0 0 0 4px;cursor:pointer;}details.dir-entry div.folders,details.dir-entry div.files{padding-left:23px;}details.dir-entry a{display:block;}details.toggle{contain:layout;position:relative;}details.toggle>summary.hideme{cursor:pointer;font-size:1rem;}details.toggle>summary{list-style:none;outline:none;}details.toggle>summary::-webkit-details-marker,details.toggle>summary::marker{display:none;}details.toggle>summary.hideme>span{margin-left:9px;}details.toggle>summary::before{background:url('data:image/svg+xml,') no-repeat top left;content:"";cursor:pointer;width:16px;height:16px;display:inline-block;vertical-align:middle;opacity:.5;filter:var(--toggle-filter);}details.toggle>summary.hideme>span,.more-examples-toggle summary,.more-examples-toggle .hide-more{color:var(--toggles-color);}details.toggle>summary::after{content:"Expand";overflow:hidden;width:0;height:0;position:absolute;}details.toggle>summary.hideme::after{content:"";}details.toggle>summary:focus::before,details.toggle>summary:hover::before{opacity:1;}details.toggle>summary:focus-visible::before{outline:1px dotted #000;outline-offset:1px;}details.non-exhaustive{margin-bottom:8px;}details.toggle>summary.hideme::before{position:relative;}details.toggle>summary:not(.hideme)::before{position:absolute;left:-24px;top:4px;}.impl-items>details.toggle>summary:not(.hideme)::before{position:absolute;left:-24px;}details.toggle[open] >summary.hideme{position:absolute;}details.toggle[open] >summary.hideme>span{display:none;}details.toggle[open] >summary::before{background:url('data:image/svg+xml,') no-repeat top left;}details.toggle[open] >summary::after{content:"Collapse";}.docblock summary>*{display:inline-block;}.docblock>.example-wrap:first-child .tooltip{margin-top:16px;}@media (max-width:700px){*[id]{scroll-margin-top:45px;}.rustdoc{display:block;}main{padding-left:15px;padding-top:0px;}.main-heading{flex-direction:column;}.out-of-band{text-align:left;margin-left:initial;padding:initial;}.out-of-band .since::before{content:"Since ";}.sidebar .logo-container,.sidebar .location{display:none;}.sidebar{position:fixed;top:45px;left:-1000px;z-index:11;height:calc(100vh - 45px);width:200px;}.source main,.rustdoc.source .sidebar{top:0;padding:0;height:100vh;border:0;}.sidebar.shown,.source-sidebar-expanded .source .sidebar,.rustdoc:not(.source) .sidebar:focus-within{left:0;}.mobile-topbar h2{padding-bottom:0;margin:auto 0.5em auto auto;overflow:hidden;font-size:24px;}.mobile-topbar h2 a{display:block;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}.mobile-topbar .logo-container>img{max-width:35px;max-height:35px;margin:5px 0 5px 20px;}.mobile-topbar{display:flex;flex-direction:row;position:sticky;z-index:10;font-size:2rem;height:45px;width:100%;left:0;top:0;}.sidebar-menu-toggle{width:45px;font-size:32px;border:none;color:var(--main-color);}.sidebar-elems{margin-top:1em;}.anchor{display:none !important;}#search-tabs .count{display:block;}#main-content>details.toggle>summary::before,#main-content>div>details.toggle>summary::before{left:-11px;}#src-sidebar-toggle{position:fixed;left:1px;top:100px;width:30px;font-size:1.5rem;padding:0;z-index:10;border-top-right-radius:3px;border-bottom-right-radius:3px;border:1px solid;border-left:0;}.source-sidebar-expanded #src-sidebar-toggle{left:unset;top:unset;width:unset;border-top-right-radius:unset;border-bottom-right-radius:unset;position:sticky;border:0;border-bottom:1px solid;}#copy-path,#help-button{display:none;}.item-table,.item-row,.item-table>li,.item-table>li>div,.search-results>a,.search-results>a>div{display:block;}.search-results>a{padding:5px 0px;}.search-results>a>div.desc,.item-table>li>div.desc{padding-left:2em;}.search-results .result-name{display:block;}.search-results .result-name .typename{width:initial;margin-right:0;}.search-results .result-name .typename,.search-results .result-name .path{display:inline;}.source-sidebar-expanded .source .sidebar{max-width:100vw;width:100vw;}details.toggle:not(.top-doc)>summary{margin-left:10px;}.impl-items>details.toggle>summary:not(.hideme)::before,#main-content>details.toggle:not(.top-doc)>summary::before,#main-content>div>details.toggle>summary::before{left:-11px;}.impl-items>.item-info{margin-left:34px;}.source nav.sub{margin:0;padding:var(--nav-sub-mobile-padding);}}@media (min-width:701px){.scraped-example-title{position:absolute;z-index:10;background:var(--main-background-color);bottom:8px;right:5px;padding:2px 4px;box-shadow:0 0 4px var(--main-background-color);}}@media print{nav.sidebar,nav.sub,.out-of-band,a.srclink,#copy-path,details.toggle[open] >summary::before,details.toggle>summary::before,details.toggle.top-doc>summary{display:none;}.docblock{margin-left:0;}main{padding:10px;}}@media (max-width:464px){.docblock{margin-left:12px;}.docblock code{overflow-wrap:break-word;overflow-wrap:anywhere;}nav.sub{flex-direction:column;}.search-form{align-self:stretch;}.sub-logo-container>img{height:35px;width:35px;margin-bottom:var(--nav-sub-mobile-padding);}}.variant,.implementors-toggle>summary,.impl,#implementors-list>.docblock,.impl-items>section,.impl-items>.toggle>summary,.methods>section,.methods>.toggle>summary{margin-bottom:0.75em;}.variants>.docblock,.implementors-toggle>.docblock,.impl-items>.toggle[open]:not(:last-child),.methods>.toggle[open]:not(:last-child),.implementors-toggle[open]:not(:last-child){margin-bottom:2em;}#trait-implementations-list .impl-items>.toggle:not(:last-child),#synthetic-implementations-list .impl-items>.toggle:not(:last-child),#blanket-implementations-list .impl-items>.toggle:not(:last-child){margin-bottom:1em;}.scraped-example-list .scrape-help{margin-left:10px;padding:0 4px;font-weight:normal;font-size:12px;position:relative;bottom:1px;border:1px solid var(--scrape-example-help-border-color);border-radius:50px;color:var(--scrape-example-help-color);}.scraped-example-list .scrape-help:hover{border-color:var(--scrape-example-help-hover-border-color);color:var(--scrape-example-help-hover-color);}.scraped-example{position:relative;}.scraped-example .code-wrapper{position:relative;display:flex;flex-direction:row;flex-wrap:wrap;width:100%;}.scraped-example:not(.expanded) .code-wrapper{max-height:calc(1.5em * 5 + 10px);}.scraped-example:not(.expanded) .code-wrapper pre{overflow-y:hidden;padding-bottom:0;max-height:calc(1.5em * 5 + 10px);}.more-scraped-examples .scraped-example:not(.expanded) .code-wrapper,.more-scraped-examples .scraped-example:not(.expanded) .code-wrapper pre{max-height:calc(1.5em * 10 + 10px);}.scraped-example .code-wrapper .next,.scraped-example .code-wrapper .prev,.scraped-example .code-wrapper .expand{color:var(--main-color);position:absolute;top:0.25em;z-index:1;padding:0;background:none;border:none;-webkit-appearance:none;opacity:1;}.scraped-example .code-wrapper .prev{right:2.25em;}.scraped-example .code-wrapper .next{right:1.25em;}.scraped-example .code-wrapper .expand{right:0.25em;}.scraped-example:not(.expanded) .code-wrapper::before,.scraped-example:not(.expanded) .code-wrapper::after{content:" ";width:100%;height:5px;position:absolute;z-index:1;}.scraped-example:not(.expanded) .code-wrapper::before{top:0;background:linear-gradient(to bottom,var(--scrape-example-code-wrapper-background-start),var(--scrape-example-code-wrapper-background-end));}.scraped-example:not(.expanded) .code-wrapper::after{bottom:0;background:linear-gradient(to top,var(--scrape-example-code-wrapper-background-start),var(--scrape-example-code-wrapper-background-end));}.scraped-example .code-wrapper .example-wrap{width:100%;overflow-y:hidden;margin-bottom:0;}.scraped-example:not(.expanded) .code-wrapper .example-wrap{overflow-x:hidden;}.scraped-example .example-wrap .rust span.highlight{background:var(--scrape-example-code-line-highlight);}.scraped-example .example-wrap .rust span.highlight.focus{background:var(--scrape-example-code-line-highlight-focus);}.more-examples-toggle{max-width:calc(100% + 25px);margin-top:10px;margin-left:-25px;}.more-examples-toggle .hide-more{margin-left:25px;cursor:pointer;}.more-scraped-examples{margin-left:25px;position:relative;}.toggle-line{position:absolute;top:5px;bottom:0;right:calc(100% + 10px);padding:0 4px;cursor:pointer;}.toggle-line-inner{min-width:2px;height:100%;background:var(--scrape-example-toggle-line-background);}.toggle-line:hover .toggle-line-inner{background:var(--scrape-example-toggle-line-hover-background);}.more-scraped-examples .scraped-example,.example-links{margin-top:20px;}.more-scraped-examples .scraped-example:first-child{margin-top:5px;}.example-links ul{margin-bottom:0;} \ No newline at end of file diff --git a/docs/doc/static.files/scrape-examples-ef1e698c1d417c0c.js b/docs/doc/static.files/scrape-examples-ef1e698c1d417c0c.js new file mode 100644 index 0000000..ba830e3 --- /dev/null +++ b/docs/doc/static.files/scrape-examples-ef1e698c1d417c0c.js @@ -0,0 +1 @@ +"use strict";(function(){const DEFAULT_MAX_LINES=5;const HIDDEN_MAX_LINES=10;function scrollToLoc(elt,loc,isHidden){const lines=elt.querySelector(".src-line-numbers");let scrollOffset;const maxLines=isHidden?HIDDEN_MAX_LINES:DEFAULT_MAX_LINES;if(loc[1]-loc[0]>maxLines){const line=Math.max(0,loc[0]-1);scrollOffset=lines.children[line].offsetTop}else{const wrapper=elt.querySelector(".code-wrapper");const halfHeight=wrapper.offsetHeight/2;const offsetTop=lines.children[loc[0]].offsetTop;const lastLine=lines.children[loc[1]];const offsetBot=lastLine.offsetTop+lastLine.offsetHeight;const offsetMid=(offsetTop+offsetBot)/2;scrollOffset=offsetMid-halfHeight}lines.scrollTo(0,scrollOffset);elt.querySelector(".rust").scrollTo(0,scrollOffset)}function updateScrapedExample(example,isHidden){const locs=JSON.parse(example.attributes.getNamedItem("data-locs").textContent);let locIndex=0;const highlights=Array.prototype.slice.call(example.querySelectorAll(".highlight"));const link=example.querySelector(".scraped-example-title a");if(locs.length>1){const onChangeLoc=changeIndex=>{removeClass(highlights[locIndex],"focus");changeIndex();scrollToLoc(example,locs[locIndex][0],isHidden);addClass(highlights[locIndex],"focus");const url=locs[locIndex][1];const title=locs[locIndex][2];link.href=url;link.innerHTML=title};example.querySelector(".prev").addEventListener("click",()=>{onChangeLoc(()=>{locIndex=(locIndex-1+locs.length)%locs.length})});example.querySelector(".next").addEventListener("click",()=>{onChangeLoc(()=>{locIndex=(locIndex+1)%locs.length})})}const expandButton=example.querySelector(".expand");if(expandButton){expandButton.addEventListener("click",()=>{if(hasClass(example,"expanded")){removeClass(example,"expanded");scrollToLoc(example,locs[0][0],isHidden)}else{addClass(example,"expanded")}})}scrollToLoc(example,locs[0][0],isHidden)}const firstExamples=document.querySelectorAll(".scraped-example-list > .scraped-example");onEachLazy(firstExamples,el=>updateScrapedExample(el,false));onEachLazy(document.querySelectorAll(".more-examples-toggle"),toggle=>{onEachLazy(toggle.querySelectorAll(".toggle-line, .hide-more"),button=>{button.addEventListener("click",()=>{toggle.open=false})});const moreExamples=toggle.querySelectorAll(".scraped-example");toggle.querySelector("summary").addEventListener("click",()=>{setTimeout(()=>{onEachLazy(moreExamples,el=>updateScrapedExample(el,true))})},{once:true})})})() \ No newline at end of file diff --git a/docs/doc/static.files/search-f6292fe389d70017.js b/docs/doc/static.files/search-f6292fe389d70017.js new file mode 100644 index 0000000..c91355a --- /dev/null +++ b/docs/doc/static.files/search-f6292fe389d70017.js @@ -0,0 +1,5 @@ +"use strict";(function(){const itemTypes=["mod","externcrate","import","struct","enum","fn","type","static","trait","impl","tymethod","method","structfield","variant","macro","primitive","associatedtype","constant","associatedconstant","union","foreigntype","keyword","existential","attr","derive","traitalias",];const longItemTypes=["module","extern crate","re-export","struct","enum","function","type alias","static","trait","","trait method","method","struct field","enum variant","macro","primitive type","assoc type","constant","assoc const","union","foreign type","keyword","existential type","attribute macro","derive macro","trait alias",];const TY_PRIMITIVE=itemTypes.indexOf("primitive");const TY_KEYWORD=itemTypes.indexOf("keyword");const ROOT_PATH=typeof window!=="undefined"?window.rootPath:"../";function hasOwnPropertyRustdoc(obj,property){return Object.prototype.hasOwnProperty.call(obj,property)}function printTab(nb){let iter=0;let foundCurrentTab=false;let foundCurrentResultSet=false;onEachLazy(document.getElementById("search-tabs").childNodes,elem=>{if(nb===iter){addClass(elem,"selected");foundCurrentTab=true}else{removeClass(elem,"selected")}iter+=1});const isTypeSearch=(nb>0||iter===1);iter=0;onEachLazy(document.getElementById("results").childNodes,elem=>{if(nb===iter){addClass(elem,"active");foundCurrentResultSet=true}else{removeClass(elem,"active")}iter+=1});if(foundCurrentTab&&foundCurrentResultSet){searchState.currentTab=nb;const correctionsElem=document.getElementsByClassName("search-corrections");if(isTypeSearch){removeClass(correctionsElem[0],"hidden")}else{addClass(correctionsElem[0],"hidden")}}else if(nb!==0){printTab(0)}}const editDistanceState={current:[],prev:[],prevPrev:[],calculate:function calculate(a,b,limit){if(a.length\
+ ${item.displayPath}${name}\
+
`);link.appendChild(resultName);const description=document.createElement("div");description.className="desc";description.insertAdjacentHTML("beforeend",item.desc);link.appendChild(description);output.appendChild(link)})}else if(query.error===null){output.className="search-failed"+extraClass;output.innerHTML="No results :("+"Try on DuckDuckGo?
"+"Or try looking in one of these:
- The Rust Reference "+" for technical details about the language.
- Rust By "+"Example for expository code examples.
- The Rust Book for "+"introductions to language features and the language itself.
- Docs.rs for documentation of crates released on"+" crates.io.
Results${crates}
`;if(results.query.error!==null){const error=results.query.error;error.forEach((value,index)=>{value=value.split("<").join("<").split(">").join(">");if(index%2!==0){error[index]=`${value.replaceAll(" ", " ")}`}else{error[index]=value}});output+=`Query parser error: "${error.join("")}".
`;output+=""+makeTabHeader(0,"In Names",ret_others[1])+"
";currentTab=0}else if(results.query.foundElems<=1&&results.query.returned.length===0){output+=""+makeTabHeader(0,"In Names",ret_others[1])+makeTabHeader(1,"In Parameters",ret_in_args[1])+makeTabHeader(2,"In Return Types",ret_returned[1])+"
"}else{const signatureTabTitle=results.query.elems.length===0?"In Function Return Types":results.query.returned.length===0?"In Function Parameters":"In Function Signatures";output+=""+makeTabHeader(0,signatureTabTitle,ret_others[1])+"
";currentTab=0}if(results.query.correction!==null){const orig=results.query.returned.length>0?results.query.returned[0].name:results.query.elems[0].name;output+=""+`Type "${orig}" not found. `+"Showing results for closest type name "+`"${results.query.correction}" instead.
`}const resultsElem=document.createElement("div");resultsElem.id="results";resultsElem.appendChild(ret_others[0]);resultsElem.appendChild(ret_in_args[0]);resultsElem.appendChild(ret_returned[0]);search.innerHTML=output;const crateSearch=document.getElementById("crate-search");if(crateSearch){crateSearch.addEventListener("input",updateCrate)}search.appendChild(resultsElem);searchState.showResults(search);const elems=document.getElementById("search-tabs").childNodes;searchState.focusedByTab=[];let i=0;for(const elem of elems){const j=i;elem.onclick=()=>printTab(j);searchState.focusedByTab.push(null);i+=1}printTab(currentTab)}function updateSearchHistory(url){if(!browserSupportsHistoryApi()){return}const params=searchState.getQueryStringParams();if(!history.state&&!params.search){history.pushState(null,"",url)}else{history.replaceState(null,"",url)}}function search(e,forced){if(e){e.preventDefault()}const query=parseQuery(searchState.input.value.trim());let filterCrates=getFilterCrates();if(!forced&&query.userQuery===currentResults){if(query.userQuery.length>0){putBackSearch()}return}searchState.setLoadingSearch();const params=searchState.getQueryStringParams();if(filterCrates===null&¶ms["filter-crate"]!==undefined){filterCrates=params["filter-crate"]}searchState.title="Results for "+query.original+" - Rust";updateSearchHistory(buildUrl(query.original,filterCrates));showResults(execQuery(query,searchWords,filterCrates,window.currentCrate),params.go_to_first,filterCrates)}function buildItemSearchTypeAll(types,lowercasePaths){const PATH_INDEX_DATA=0;const GENERICS_DATA=1;return types.map(type=>{let pathIndex,generics;if(typeof type==="number"){pathIndex=type;generics=[]}else{pathIndex=type[PATH_INDEX_DATA];generics=buildItemSearchTypeAll(type[GENERICS_DATA],lowercasePaths)}return{id:pathIndex===0?-1:buildTypeMapIndex(lowercasePaths[pathIndex-1].name),ty:pathIndex===0?null:lowercasePaths[pathIndex-1].ty,generics:generics,}})}function buildFunctionSearchType(functionSearchType,lowercasePaths){const INPUTS_DATA=0;const OUTPUT_DATA=1;if(functionSearchType===0){return null}let inputs,output;if(typeof functionSearchType[INPUTS_DATA]==="number"){const pathIndex=functionSearchType[INPUTS_DATA];inputs=[{id:pathIndex===0?-1:buildTypeMapIndex(lowercasePaths[pathIndex-1].name),ty:pathIndex===0?null:lowercasePaths[pathIndex-1].ty,generics:[],}]}else{inputs=buildItemSearchTypeAll(functionSearchType[INPUTS_DATA],lowercasePaths)}if(functionSearchType.length>1){if(typeof functionSearchType[OUTPUT_DATA]==="number"){const pathIndex=functionSearchType[OUTPUT_DATA];output=[{id:pathIndex===0?-1:buildTypeMapIndex(lowercasePaths[pathIndex-1].name),ty:pathIndex===0?null:lowercasePaths[pathIndex-1].ty,generics:[],}]}else{output=buildItemSearchTypeAll(functionSearchType[OUTPUT_DATA],lowercasePaths)}}else{output=[]}return{inputs,output,}}function buildIndex(rawSearchIndex){searchIndex=[];const searchWords=[];typeNameIdMap=new Map();const charA="A".charCodeAt(0);let currentIndex=0;let id=0;typeNameIdOfArray=buildTypeMapIndex("array");typeNameIdOfSlice=buildTypeMapIndex("slice");typeNameIdOfArrayOrSlice=buildTypeMapIndex("[]");for(const crate in rawSearchIndex){if(!hasOwnPropertyRustdoc(rawSearchIndex,crate)){continue}let crateSize=0;const crateCorpus=rawSearchIndex[crate];searchWords.push(crate);const crateRow={crate:crate,ty:1,name:crate,path:"",desc:crateCorpus.doc,parent:undefined,type:null,id:id,normalizedName:crate.indexOf("_")===-1?crate:crate.replace(/_/g,""),deprecated:null,};id+=1;searchIndex.push(crateRow);currentIndex+=1;const itemTypes=crateCorpus.t;const itemNames=crateCorpus.n;const itemPaths=new Map(crateCorpus.q);const itemDescs=crateCorpus.d;const itemParentIdxs=crateCorpus.i;const itemFunctionSearchTypes=crateCorpus.f;const deprecatedItems=new Set(crateCorpus.c);const paths=crateCorpus.p;const aliases=crateCorpus.a;const lowercasePaths=[];let len=paths.length;for(let i=0;i
+
`}else{const checked=setting["default"]===true?" checked":"";output+=`\
+${setting_name}
+ `;onEach(setting["options"],option=>{const checked=option===setting["default"]?" checked":"";const full=`${js_data_name}-${option.replace(/ /g,"-")}`;output+=`\
+ `});output+=`\
+
+\
+ \
+
`}}return output}function buildSettingsPage(){const theme_names=getVar("themes").split(",").filter(t=>t);theme_names.push("light","dark","ayu");const settings=[{"name":"Theme","js_name":"theme","default":"system preference","options":theme_names.concat("system preference"),},{"name":"Preferred light theme","js_name":"preferred-light-theme","default":"light","options":theme_names,},{"name":"Preferred dark theme","js_name":"preferred-dark-theme","default":"dark","options":theme_names,},{"name":"Auto-hide item contents for large items","js_name":"auto-hide-large-items","default":true,},{"name":"Auto-hide item methods' documentation","js_name":"auto-hide-method-docs","default":false,},{"name":"Auto-hide trait implementation documentation","js_name":"auto-hide-trait-implementations","default":false,},{"name":"Directly go to item in search if there is only one result","js_name":"go-to-only-result","default":false,},{"name":"Show line numbers on code examples","js_name":"line-numbers","default":false,},{"name":"Disable keyboard shortcuts","js_name":"disable-shortcuts","default":false,},];const elementKind=isSettingsPage?"section":"div";const innerHTML=`${buildSettingsPageSections(settings)}
`;const el=document.createElement(elementKind);el.id="settings";if(!isSettingsPage){el.className="popover"}el.innerHTML=innerHTML;if(isSettingsPage){document.getElementById(MAIN_ID).appendChild(el)}else{el.setAttribute("tabindex","-1");getSettingsButton().appendChild(el)}return el}const settingsMenu=buildSettingsPage();function displaySettings(){settingsMenu.style.display=""}function settingsBlurHandler(event){blurHandler(event,getSettingsButton(),window.hidePopoverMenus)}if(isSettingsPage){getSettingsButton().onclick=function(event){event.preventDefault()}}else{const settingsButton=getSettingsButton();const settingsMenu=document.getElementById("settings");settingsButton.onclick=function(event){if(elemIsInParent(event.target,settingsMenu)){return}event.preventDefault();const shouldDisplaySettings=settingsMenu.style.display==="none";window.hideAllModals();if(shouldDisplaySettings){displaySettings()}};settingsButton.onblur=settingsBlurHandler;settingsButton.querySelector("a").onblur=settingsBlurHandler;onEachLazy(settingsMenu.querySelectorAll("input"),el=>{el.onblur=settingsBlurHandler});settingsMenu.onblur=settingsBlurHandler}setTimeout(()=>{setEvents(settingsMenu);if(!isSettingsPage){displaySettings()}removeClass(getSettingsButton(),"rotate")},0)})()
\ No newline at end of file
diff --git a/docs/doc/static.files/source-script-106908c7a7964ba4.js b/docs/doc/static.files/source-script-106908c7a7964ba4.js
new file mode 100644
index 0000000..191bf6d
--- /dev/null
+++ b/docs/doc/static.files/source-script-106908c7a7964ba4.js
@@ -0,0 +1 @@
+"use strict";(function(){const rootPath=getVar("root-path");const NAME_OFFSET=0;const DIRS_OFFSET=1;const FILES_OFFSET=2;const RUSTDOC_MOBILE_BREAKPOINT=700;function closeSidebarIfMobile(){if(window.innerWidth
List of all items
Structs
Enums
Macros
List of all items
Structs
Enums
Macros
- Module ubits::
source · [−]
Module ubits::examples::flagless_example
source · [−]Expand description
Example of generated output, using only a bit field without a flag enum.
+Module ubits::examples::flagless_example
source · Expand description
Example of generated output, using only a bit field without a flag enum.
This module is only compiled with documentation builds and will not be available for import.
-use the bitfield macro to generate a field struct and flag enum.
Structs
-Optional docstring for my example bit field.
-use the bitfield macro to generate a field struct and flag enum.
Structs
- Optional docstring for my example bit field.
- Struct ubits::
source · [−]
Struct ubits::examples::flagless_example::ExampleField
source · [−]pub struct ExampleField(_);Expand description
Optional docstring for my example bit field.
-Implementations
sourceimpl ExampleField
impl ExampleField
Constant values describing ExampleField.
sourcepub const BITS: usize
pub const BITS: usize
Number of bits in an instance of ExampleField.
sourcepub const BYTES: usize
pub const BYTES: usize
Number of bytes used by an instance of ExampleField.
sourcepub const MAX: u8
pub const MAX: u8
Maximum valid integer for ExampleField.
sourceimpl ExampleField
impl ExampleField
Constructors for creating instances of ExampleField.
sourcepub fn new(value: u8) -> Self
pub fn new(value: u8) -> Self
Create a new instance of ExampleField from a u8 value.
sourcepub fn zeros() -> Self
pub fn zeros() -> Self
Create a new instance of ExampleField from 0.
sourcepub fn ones() -> Self
pub fn ones() -> Self
Create a new instance of ExampleField from the maximum possible integer value.
sourcepub fn from_binary_str(value: &str) -> Self
pub fn from_binary_str(value: &str) -> Self
Create a new instance of ExampleField from a binary string.
sourcepub fn from_binary_string(value: String) -> Self
pub fn from_binary_string(value: String) -> Self
Create a new instance of ExampleField from a binary string.
sourceimpl ExampleField
impl ExampleField
Current state of this bitfield.
-sourceimpl ExampleField
impl ExampleField
Field accessors by index for ExampleField.
sourcepub fn get_index(&self, index: u8) -> bool
pub fn get_index(&self, index: u8) -> bool
Returns the value of the bit at the supplied index as a boolean.
-sourcepub fn clear_index(&mut self, index: u8)
pub fn clear_index(&mut self, index: u8)
Sets the value of the bit at the supplied index to 0.
sourcepub fn toggle_index(&mut self, index: u8)
pub fn toggle_index(&mut self, index: u8)
Flips the value of the bit at the supplied index.
-sourceimpl ExampleField
impl ExampleField
Combinators for ExampleField.
sourcepub fn diff(&self, other: Self) -> Self
pub fn diff(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Does not consume self.
sourcepub fn combine(&self, other: Self) -> Self
pub fn combine(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Does not consume self.
sourcepub fn intersect(&self, other: Self) -> Self
pub fn intersect(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Does not consume self.
sourceimpl ExampleField
impl ExampleField
Conversion methods.
-sourcepub fn into_diff(self, other: Self) -> Self
pub fn into_diff(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Consumes self.
sourcepub fn into_combined(self, other: Self) -> Self
pub fn into_combined(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Consumes self.
sourcepub fn into_intersection(self, other: Self) -> Self
pub fn into_intersection(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Consumes self.
Trait Implementations
sourceimpl Binary for ExampleField
impl Binary for ExampleField
sourceimpl BitAnd<ExampleField> for ExampleField
impl BitAnd<ExampleField> for ExampleField
sourceimpl BitAndAssign<ExampleField> for ExampleField
impl BitAndAssign<ExampleField> for ExampleField
sourcefn bitand_assign(&mut self, rhs: Self)
fn bitand_assign(&mut self, rhs: Self)
Performs the &= operation. Read more
sourceimpl BitOr<ExampleField> for ExampleField
impl BitOr<ExampleField> for ExampleField
sourceimpl BitOrAssign<ExampleField> for ExampleField
impl BitOrAssign<ExampleField> for ExampleField
sourcefn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
Performs the |= operation. Read more
sourceimpl BitXor<ExampleField> for ExampleField
impl BitXor<ExampleField> for ExampleField
sourceimpl BitXorAssign<ExampleField> for ExampleField
impl BitXorAssign<ExampleField> for ExampleField
sourcefn bitxor_assign(&mut self, rhs: Self)
fn bitxor_assign(&mut self, rhs: Self)
Performs the ^= operation. Read more
sourceimpl Clone for ExampleField
impl Clone for ExampleField
sourcefn clone(&self) -> ExampleField
fn clone(&self) -> ExampleField
Returns a copy of the value. Read more
-1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for ExampleField
impl Debug for ExampleField
sourceimpl Default for ExampleField
impl Default for ExampleField
sourceimpl From<u8> for ExampleField
impl From<u8> for ExampleField
Returns a field instance from value of its underlying type.
-sourcefn from(value: u8) -> ExampleField
fn from(value: u8) -> ExampleField
Performs the conversion.
-sourceimpl PartialEq<ExampleField> for ExampleField
impl PartialEq<ExampleField> for ExampleField
sourcefn eq(&self, other: &ExampleField) -> bool
fn eq(&self, other: &ExampleField) -> bool
This method tests for self and other values to be equal, and is used
-by ==. Read more
sourcefn ne(&self, other: &ExampleField) -> bool
fn ne(&self, other: &ExampleField) -> bool
This method tests for !=.
sourceimpl PartialOrd<ExampleField> for ExampleField
impl PartialOrd<ExampleField> for ExampleField
sourcefn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
-operator. Read more
impl Copy for ExampleField
impl StructuralPartialEq for ExampleField
Auto Trait Implementations
impl RefUnwindSafe for ExampleField
impl Send for ExampleField
impl Sync for ExampleField
impl Unpin for ExampleField
impl UnwindSafe for ExampleField
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
-sourceimpl<T, U> Into<U> for T where
U: From<T>,
impl<T, U> Into<U> for T where
U: From<T>,
const: unstable · sourcepub fn into(self) -> U
pub fn into(self) -> U
Calls U::from(self).
Struct ubits::examples::flagless_example::ExampleField
source · pub struct ExampleField(_);Expand description
Optional docstring for my example bit field.
+Implementations§
source§impl ExampleField
impl ExampleField
Constant values describing ExampleField.
sourcepub const BITS: usize = 8usize
pub const BITS: usize = 8usize
Number of bits in an instance of ExampleField.
sourcepub const BYTES: usize = 1usize
pub const BYTES: usize = 1usize
Number of bytes used by an instance of ExampleField.
sourcepub const MAX: u8 = 255u8
pub const MAX: u8 = 255u8
Maximum valid integer for ExampleField.
source§impl ExampleField
impl ExampleField
Constructors for creating instances of ExampleField.
sourcepub fn new(value: u8) -> Self
pub fn new(value: u8) -> Self
Create a new instance of ExampleField from a u8 value.
sourcepub fn zeros() -> Self
pub fn zeros() -> Self
Create a new instance of ExampleField from 0.
sourcepub fn ones() -> Self
pub fn ones() -> Self
Create a new instance of ExampleField from the maximum possible integer value.
sourcepub fn from_binary_str(value: &str) -> Self
pub fn from_binary_str(value: &str) -> Self
Create a new instance of ExampleField from a binary string.
sourcepub fn from_binary_string(value: String) -> Self
pub fn from_binary_string(value: String) -> Self
Create a new instance of ExampleField from a binary string.
source§impl ExampleField
impl ExampleField
Current state of this bitfield.
+source§impl ExampleField
impl ExampleField
Field accessors by index for ExampleField.
sourcepub fn get_index(&self, index: u8) -> bool
pub fn get_index(&self, index: u8) -> bool
Returns the value of the bit at the supplied index as a boolean.
+sourcepub fn clear_index(&mut self, index: u8)
pub fn clear_index(&mut self, index: u8)
Sets the value of the bit at the supplied index to 0.
sourcepub fn toggle_index(&mut self, index: u8)
pub fn toggle_index(&mut self, index: u8)
Flips the value of the bit at the supplied index.
+source§impl ExampleField
impl ExampleField
Combinators for ExampleField.
sourcepub fn diff(&self, other: Self) -> Self
pub fn diff(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Does not consume self.
sourcepub fn combine(&self, other: Self) -> Self
pub fn combine(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Does not consume self.
sourcepub fn intersect(&self, other: Self) -> Self
pub fn intersect(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Does not consume self.
source§impl ExampleField
impl ExampleField
Conversion methods.
+sourcepub fn into_diff(self, other: Self) -> Self
pub fn into_diff(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Consumes self.
sourcepub fn into_combined(self, other: Self) -> Self
pub fn into_combined(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Consumes self.
sourcepub fn into_intersection(self, other: Self) -> Self
pub fn into_intersection(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Consumes self.
Trait Implementations§
source§impl Binary for ExampleField
impl Binary for ExampleField
source§impl BitAnd<ExampleField> for ExampleField
impl BitAnd<ExampleField> for ExampleField
source§impl BitAndAssign<ExampleField> for ExampleField
impl BitAndAssign<ExampleField> for ExampleField
source§fn bitand_assign(&mut self, rhs: Self)
fn bitand_assign(&mut self, rhs: Self)
Performs the
&= operation. Read moresource§impl BitOr<ExampleField> for ExampleField
impl BitOr<ExampleField> for ExampleField
source§impl BitOrAssign<ExampleField> for ExampleField
impl BitOrAssign<ExampleField> for ExampleField
source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
Performs the
|= operation. Read moresource§impl BitXor<ExampleField> for ExampleField
impl BitXor<ExampleField> for ExampleField
source§impl BitXorAssign<ExampleField> for ExampleField
impl BitXorAssign<ExampleField> for ExampleField
source§fn bitxor_assign(&mut self, rhs: Self)
fn bitxor_assign(&mut self, rhs: Self)
Performs the
^= operation. Read moresource§impl Clone for ExampleField
impl Clone for ExampleField
source§fn clone(&self) -> ExampleField
fn clone(&self) -> ExampleField
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for ExampleField
impl Debug for ExampleField
source§impl Default for ExampleField
impl Default for ExampleField
source§impl From<u8> for ExampleField
impl From<u8> for ExampleField
Returns a field instance from value of its underlying type.
+source§fn from(value: u8) -> ExampleField
fn from(value: u8) -> ExampleField
Converts to this type from the input type.
source§impl PartialEq<ExampleField> for ExampleField
impl PartialEq<ExampleField> for ExampleField
source§fn eq(&self, other: &ExampleField) -> bool
fn eq(&self, other: &ExampleField) -> bool
This method tests for
self and other values to be equal, and is used
+by ==.source§impl PartialOrd<ExampleField> for ExampleField
impl PartialOrd<ExampleField> for ExampleField
source§fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self and other) and is used by the <=
+operator. Read moreimpl Copy for ExampleField
impl StructuralPartialEq for ExampleField
Auto Trait Implementations§
impl RefUnwindSafe for ExampleField
impl Send for ExampleField
impl Sync for ExampleField
impl Unpin for ExampleField
impl UnwindSafe for ExampleField
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
impl<T> BorrowMut<T> for Twhere + T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
-sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
-sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
-From<T> for U chooses to do.
+
- Enum ubits::
source · [−]
Enum ubits::examples::full_example::ExampleFlags
source · [−]#[repr(u8)]
-pub enum ExampleFlags {
+ExampleFlags in ubits::examples::full_example - Rust Enum ubits::examples::full_example::ExampleFlags
source · #[repr(u8)]pub enum ExampleFlags {
Flag0,
Flag1,
Flag2,
@@ -14,78 +7,35 @@ Enum ubits:
Flag5,
Flag6,
Flag7,
-}
Expand description
Optional docstring for my flag enum.
-Variants
Flag0
Optional docstring for Flag0
-Flag1
Optional docstring for Flag1
-Flag2
Optional docstring for Flag2
-Flag3
Optional docstring for Flag3
-Flag4
Optional docstring for Flag4
-Flag5
Optional docstring for Flag5
-Flag6
Optional docstring for Flag6
-Flag7
Optional docstring for Flag7
-Trait Implementations
sourceimpl BitAnd<ExampleFlags> for ExampleFlags
sourceimpl BitAnd<ExampleFlags> for ExampleField
type Output = ExampleField
The resulting type after applying the & operator.
-sourcefn bitand(self, rhs: ExampleFlags) -> Self::Output
Performs the & operation. Read more
-sourceimpl BitAnd<ExampleFlags> for &ExampleField
type Output = ExampleField
The resulting type after applying the & operator.
-sourcefn bitand(self, rhs: ExampleFlags) -> Self::Output
Performs the & operation. Read more
-sourceimpl BitAnd<ExampleFlags> for &mut ExampleField
type Output = ExampleField
The resulting type after applying the & operator.
-sourcefn bitand(self, rhs: ExampleFlags) -> Self::Output
Performs the & operation. Read more
-sourceimpl BitAndAssign<ExampleFlags> for ExampleField
sourcefn bitand_assign(&mut self, rhs: ExampleFlags)
Performs the &= operation. Read more
-sourceimpl BitOr<ExampleFlags> for ExampleFlags
sourceimpl BitOr<ExampleFlags> for ExampleField
type Output = ExampleField
The resulting type after applying the | operator.
-sourcefn bitor(self, rhs: ExampleFlags) -> Self::Output
Performs the | operation. Read more
-sourceimpl BitOr<ExampleFlags> for &ExampleField
type Output = ExampleField
The resulting type after applying the | operator.
-sourcefn bitor(self, rhs: ExampleFlags) -> Self::Output
Performs the | operation. Read more
-sourceimpl BitOr<ExampleFlags> for &mut ExampleField
type Output = ExampleField
The resulting type after applying the | operator.
-sourcefn bitor(self, rhs: ExampleFlags) -> Self::Output
Performs the | operation. Read more
-sourceimpl BitOrAssign<ExampleFlags> for ExampleField
sourcefn bitor_assign(&mut self, rhs: ExampleFlags)
Performs the |= operation. Read more
-sourceimpl BitXor<ExampleFlags> for ExampleFlags
sourceimpl BitXor<ExampleFlags> for ExampleField
type Output = ExampleField
The resulting type after applying the ^ operator.
-sourcefn bitxor(self, rhs: ExampleFlags) -> Self::Output
Performs the ^ operation. Read more
-sourceimpl BitXor<ExampleFlags> for &ExampleField
type Output = ExampleField
The resulting type after applying the ^ operator.
-sourcefn bitxor(self, rhs: ExampleFlags) -> Self::Output
Performs the ^ operation. Read more
-sourceimpl BitXor<ExampleFlags> for &mut ExampleField
type Output = ExampleField
The resulting type after applying the ^ operator.
-sourcefn bitxor(self, rhs: ExampleFlags) -> Self::Output
Performs the ^ operation. Read more
-sourceimpl BitXorAssign<ExampleFlags> for ExampleField
sourcefn bitxor_assign(&mut self, rhs: ExampleFlags)
Performs the ^= operation. Read more
-sourceimpl Clone for ExampleFlags
sourcefn clone(&self) -> ExampleFlags
Returns a copy of the value. Read more
-1.0.0 · sourcefn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
-sourceimpl Debug for ExampleFlags
sourceimpl From<ExampleFlags> for u8
Returns a flag as its corresponding u8 value.
-sourcefn from(value: ExampleFlags) -> u8
Performs the conversion.
-sourceimpl From<ExampleFlags> for ExampleField
Returns a field instance from a flag.
-sourcefn from(value: ExampleFlags) -> ExampleField
Performs the conversion.
-sourceimpl From<u8> for ExampleFlags
Converts a u8 to a flag
+}Expand description
Optional docstring for my flag enum.
+Variants§
§Flag0
Optional docstring for Flag0
+§Flag1
Optional docstring for Flag1
+§Flag2
Optional docstring for Flag2
+§Flag3
Optional docstring for Flag3
+§Flag4
Optional docstring for Flag4
+§Flag5
Optional docstring for Flag5
+§Flag6
Optional docstring for Flag6
+§Flag7
Optional docstring for Flag7
+Trait Implementations§
source§impl BitAnd<ExampleFlags> for &ExampleField
§type Output = ExampleField
The resulting type after applying the & operator.source§impl BitAnd<ExampleFlags> for &mut ExampleField
§type Output = ExampleField
The resulting type after applying the & operator.source§impl BitAnd<ExampleFlags> for ExampleField
§type Output = ExampleField
The resulting type after applying the & operator.source§impl BitAnd<ExampleFlags> for ExampleFlags
source§impl BitAndAssign<ExampleFlags> for ExampleField
source§fn bitand_assign(&mut self, rhs: ExampleFlags)
Performs the &= operation. Read moresource§impl BitOr<ExampleFlags> for &ExampleField
§type Output = ExampleField
The resulting type after applying the | operator.source§impl BitOr<ExampleFlags> for &mut ExampleField
§type Output = ExampleField
The resulting type after applying the | operator.source§impl BitOr<ExampleFlags> for ExampleField
§type Output = ExampleField
The resulting type after applying the | operator.source§impl BitOr<ExampleFlags> for ExampleFlags
source§impl BitOrAssign<ExampleFlags> for ExampleField
source§fn bitor_assign(&mut self, rhs: ExampleFlags)
Performs the |= operation. Read moresource§impl BitXor<ExampleFlags> for &ExampleField
§type Output = ExampleField
The resulting type after applying the ^ operator.source§impl BitXor<ExampleFlags> for &mut ExampleField
§type Output = ExampleField
The resulting type after applying the ^ operator.source§impl BitXor<ExampleFlags> for ExampleField
§type Output = ExampleField
The resulting type after applying the ^ operator.source§impl BitXor<ExampleFlags> for ExampleFlags
source§impl BitXorAssign<ExampleFlags> for ExampleField
source§fn bitxor_assign(&mut self, rhs: ExampleFlags)
Performs the ^= operation. Read moresource§impl Clone for ExampleFlags
source§fn clone(&self) -> ExampleFlags
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExampleFlags
source§impl From<ExampleFlags> for ExampleField
Returns a field instance from a flag.
+source§fn from(value: ExampleFlags) -> ExampleField
Converts to this type from the input type.source§impl From<ExampleFlags> for u8
Returns a flag as its corresponding u8 value.
+source§fn from(value: ExampleFlags) -> u8
Converts to this type from the input type.source§impl From<u8> for ExampleFlags
Converts a u8 to a flag
Errors
-Panics if the supplied u8 is out of range for fields base type.
-eg: for a 16-bit field (using u16),
+
Panics if the supplied u8 is out of range for fields base type.
+eg: for a 16-bit field (using u16),
providing an index of 20 will cause a panic.
-sourcefn from(value: u8) -> ExampleFlags
Performs the conversion.
-sourceimpl PartialEq<ExampleFlags> for ExampleFlags
sourceimpl PartialOrd<ExampleFlags> for ExampleFlags
sourcefn partial_cmp(&self, other: &ExampleFlags) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
-1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
-1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
-operator. Read more
-sourceimpl Copy for ExampleFlags
sourceimpl StructuralPartialEq for ExampleFlags
sourceimpl TriviallyTransmutable for ExampleFlags
Auto Trait Implementations
impl RefUnwindSafe for ExampleFlags
impl Send for ExampleFlags
impl Sync for ExampleFlags
impl Unpin for ExampleFlags
impl UnwindSafe for ExampleFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
-sourceimpl<T, U> Into<U> for T where
U: From<T>,
const: unstable · sourcepub fn into(self) -> U
Calls U::from(self).
+source§fn from(value: u8) -> ExampleFlags
Converts to this type from the input type.source§impl PartialEq<ExampleFlags> for ExampleFlags
source§fn eq(&self, other: &ExampleFlags) -> bool
This method tests for self and other values to be equal, and is used
+by ==.source§impl PartialOrd<ExampleFlags> for ExampleFlags
source§fn partial_cmp(&self, other: &ExampleFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
+operator. Read moresource§impl Copy for ExampleFlags
source§impl StructuralPartialEq for ExampleFlags
source§impl TriviallyTransmutable for ExampleFlags
Auto Trait Implementations§
§impl RefUnwindSafe for ExampleFlags
§impl Send for ExampleFlags
§impl Sync for ExampleFlags
§impl Unpin for ExampleFlags
§impl UnwindSafe for ExampleFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresourceimpl<T> ToOwned for T where
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
-sourcepub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
-sourcepub fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
-
-
\ No newline at end of file
+From<T> for U chooses to do.
+
- Module ubits::
source · [−]
Module ubits::examples::full_example
source · [−]Expand description
Example of generated output, using both a bit field and a flag enum.
+Module ubits::examples::full_example
source · Expand description
Example of generated output, using both a bit field and a flag enum.
This module is only compiled with documentation builds and will not be available for import.
-use the bitfield macro to generate a field struct and flag enum.
Structs
-Optional docstring for my example bit field.
-Enums
-Optional docstring for my flag enum.
-use the bitfield macro to generate a field struct and flag enum.
Structs
- Optional docstring for my example bit field.
Enums
- Optional docstring for my flag enum.
- Struct ubits::
source · [−]
Struct ubits::examples::full_example::ExampleField
source · [−]pub struct ExampleField(_);Expand description
Optional docstring for my example bit field.
-Implementations
sourceimpl ExampleField
impl ExampleField
Constant values describing ExampleField.
sourcepub const BITS: usize
pub const BITS: usize
Number of bits in an instance of ExampleField.
sourcepub const BYTES: usize
pub const BYTES: usize
Number of bytes used by an instance of ExampleField.
sourcepub const MAX: u8
pub const MAX: u8
Maximum valid integer for ExampleField.
sourceimpl ExampleField
impl ExampleField
Constructors for creating instances of ExampleField.
sourcepub fn new(value: u8) -> Self
pub fn new(value: u8) -> Self
Create a new instance of ExampleField from a u8 value.
sourcepub fn zeros() -> Self
pub fn zeros() -> Self
Create a new instance of ExampleField from 0.
sourcepub fn ones() -> Self
pub fn ones() -> Self
Create a new instance of ExampleField from the maximum possible integer value.
sourcepub fn from_binary_str(value: &str) -> Self
pub fn from_binary_str(value: &str) -> Self
Create a new instance of ExampleField from a binary string.
sourcepub fn from_binary_string(value: String) -> Self
pub fn from_binary_string(value: String) -> Self
Create a new instance of ExampleField from a binary string.
sourceimpl ExampleField
impl ExampleField
Current state of this bitfield.
-sourceimpl ExampleField
impl ExampleField
Field accessors by index for ExampleField.
sourcepub fn get_index(&self, index: u8) -> bool
pub fn get_index(&self, index: u8) -> bool
Returns the value of the bit at the supplied index as a boolean.
-sourcepub fn clear_index(&mut self, index: u8)
pub fn clear_index(&mut self, index: u8)
Sets the value of the bit at the supplied index to 0.
sourcepub fn toggle_index(&mut self, index: u8)
pub fn toggle_index(&mut self, index: u8)
Flips the value of the bit at the supplied index.
-sourceimpl ExampleField
impl ExampleField
Named field accessors by ExampleFlags for ExampleField.
sourcepub fn get(&self, flag: ExampleFlags) -> bool
pub fn get(&self, flag: ExampleFlags) -> bool
Returns the value of the bit at the supplied flag as a boolean.
-sourcepub fn set(&mut self, flag: ExampleFlags) -> &mut Self
pub fn set(&mut self, flag: ExampleFlags) -> &mut Self
Sets the value of the bit at the supplied flag to 1.
sourcepub fn clear(&mut self, flag: ExampleFlags) -> &mut Self
pub fn clear(&mut self, flag: ExampleFlags) -> &mut Self
Sets the value of the bit at the supplied flag to 0.
sourcepub fn toggle(&mut self, flag: ExampleFlags) -> &mut Self
pub fn toggle(&mut self, flag: ExampleFlags) -> &mut Self
Flips the value of the bit at the supplied flag.
-sourceimpl ExampleField
impl ExampleField
Combinators for ExampleField.
sourcepub fn diff(&self, other: Self) -> Self
pub fn diff(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Does not consume self.
sourcepub fn combine(&self, other: Self) -> Self
pub fn combine(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Does not consume self.
sourcepub fn intersect(&self, other: Self) -> Self
pub fn intersect(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Does not consume self.
sourceimpl ExampleField
impl ExampleField
Conversion methods.
-sourcepub fn into_diff(self, other: Self) -> Self
pub fn into_diff(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Consumes self.
sourcepub fn into_combined(self, other: Self) -> Self
pub fn into_combined(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Consumes self.
sourcepub fn into_intersection(self, other: Self) -> Self
pub fn into_intersection(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Consumes self.
Trait Implementations
sourceimpl Binary for ExampleField
impl Binary for ExampleField
sourceimpl BitAnd<ExampleField> for ExampleField
impl BitAnd<ExampleField> for ExampleField
sourceimpl BitAnd<ExampleFlags> for ExampleField
impl BitAnd<ExampleFlags> for ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the & operator.
sourcefn bitand(self, rhs: ExampleFlags) -> Self::Output
fn bitand(self, rhs: ExampleFlags) -> Self::Output
Performs the & operation. Read more
sourceimpl BitAnd<ExampleFlags> for &ExampleField
impl BitAnd<ExampleFlags> for &ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the & operator.
sourcefn bitand(self, rhs: ExampleFlags) -> Self::Output
fn bitand(self, rhs: ExampleFlags) -> Self::Output
Performs the & operation. Read more
sourceimpl BitAnd<ExampleFlags> for &mut ExampleField
impl BitAnd<ExampleFlags> for &mut ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the & operator.
sourcefn bitand(self, rhs: ExampleFlags) -> Self::Output
fn bitand(self, rhs: ExampleFlags) -> Self::Output
Performs the & operation. Read more
sourceimpl BitAndAssign<ExampleField> for ExampleField
impl BitAndAssign<ExampleField> for ExampleField
sourcefn bitand_assign(&mut self, rhs: Self)
fn bitand_assign(&mut self, rhs: Self)
Performs the &= operation. Read more
sourceimpl BitAndAssign<ExampleFlags> for ExampleField
impl BitAndAssign<ExampleFlags> for ExampleField
sourcefn bitand_assign(&mut self, rhs: ExampleFlags)
fn bitand_assign(&mut self, rhs: ExampleFlags)
Performs the &= operation. Read more
sourceimpl BitOr<ExampleField> for ExampleField
impl BitOr<ExampleField> for ExampleField
sourceimpl BitOr<ExampleFlags> for ExampleField
impl BitOr<ExampleFlags> for ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the | operator.
sourcefn bitor(self, rhs: ExampleFlags) -> Self::Output
fn bitor(self, rhs: ExampleFlags) -> Self::Output
Performs the | operation. Read more
sourceimpl BitOr<ExampleFlags> for &ExampleField
impl BitOr<ExampleFlags> for &ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the | operator.
sourcefn bitor(self, rhs: ExampleFlags) -> Self::Output
fn bitor(self, rhs: ExampleFlags) -> Self::Output
Performs the | operation. Read more
sourceimpl BitOr<ExampleFlags> for &mut ExampleField
impl BitOr<ExampleFlags> for &mut ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the | operator.
sourcefn bitor(self, rhs: ExampleFlags) -> Self::Output
fn bitor(self, rhs: ExampleFlags) -> Self::Output
Performs the | operation. Read more
sourceimpl BitOrAssign<ExampleField> for ExampleField
impl BitOrAssign<ExampleField> for ExampleField
sourcefn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
Performs the |= operation. Read more
sourceimpl BitOrAssign<ExampleFlags> for ExampleField
impl BitOrAssign<ExampleFlags> for ExampleField
sourcefn bitor_assign(&mut self, rhs: ExampleFlags)
fn bitor_assign(&mut self, rhs: ExampleFlags)
Performs the |= operation. Read more
sourceimpl BitXor<ExampleField> for ExampleField
impl BitXor<ExampleField> for ExampleField
sourceimpl BitXor<ExampleFlags> for ExampleField
impl BitXor<ExampleFlags> for ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the ^ operator.
sourcefn bitxor(self, rhs: ExampleFlags) -> Self::Output
fn bitxor(self, rhs: ExampleFlags) -> Self::Output
Performs the ^ operation. Read more
sourceimpl BitXor<ExampleFlags> for &ExampleField
impl BitXor<ExampleFlags> for &ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the ^ operator.
sourcefn bitxor(self, rhs: ExampleFlags) -> Self::Output
fn bitxor(self, rhs: ExampleFlags) -> Self::Output
Performs the ^ operation. Read more
sourceimpl BitXor<ExampleFlags> for &mut ExampleField
impl BitXor<ExampleFlags> for &mut ExampleField
type Output = ExampleField
type Output = ExampleField
The resulting type after applying the ^ operator.
sourcefn bitxor(self, rhs: ExampleFlags) -> Self::Output
fn bitxor(self, rhs: ExampleFlags) -> Self::Output
Performs the ^ operation. Read more
sourceimpl BitXorAssign<ExampleField> for ExampleField
impl BitXorAssign<ExampleField> for ExampleField
sourcefn bitxor_assign(&mut self, rhs: Self)
fn bitxor_assign(&mut self, rhs: Self)
Performs the ^= operation. Read more
sourceimpl BitXorAssign<ExampleFlags> for ExampleField
impl BitXorAssign<ExampleFlags> for ExampleField
sourcefn bitxor_assign(&mut self, rhs: ExampleFlags)
fn bitxor_assign(&mut self, rhs: ExampleFlags)
Performs the ^= operation. Read more
sourceimpl Clone for ExampleField
impl Clone for ExampleField
sourcefn clone(&self) -> ExampleField
fn clone(&self) -> ExampleField
Returns a copy of the value. Read more
-1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for ExampleField
impl Debug for ExampleField
sourceimpl Default for ExampleField
impl Default for ExampleField
sourceimpl From<ExampleFlags> for ExampleField
impl From<ExampleFlags> for ExampleField
Returns a field instance from a flag.
-sourcefn from(value: ExampleFlags) -> ExampleField
fn from(value: ExampleFlags) -> ExampleField
Performs the conversion.
-sourceimpl From<u8> for ExampleField
impl From<u8> for ExampleField
Returns a field instance from value of its underlying type.
-sourcefn from(value: u8) -> ExampleField
fn from(value: u8) -> ExampleField
Performs the conversion.
-sourceimpl PartialEq<ExampleField> for ExampleField
impl PartialEq<ExampleField> for ExampleField
sourcefn eq(&self, other: &ExampleField) -> bool
fn eq(&self, other: &ExampleField) -> bool
This method tests for self and other values to be equal, and is used
-by ==. Read more
sourcefn ne(&self, other: &ExampleField) -> bool
fn ne(&self, other: &ExampleField) -> bool
This method tests for !=.
sourceimpl PartialOrd<ExampleField> for ExampleField
impl PartialOrd<ExampleField> for ExampleField
sourcefn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
-operator. Read more
impl Copy for ExampleField
impl StructuralPartialEq for ExampleField
Auto Trait Implementations
impl RefUnwindSafe for ExampleField
impl Send for ExampleField
impl Sync for ExampleField
impl Unpin for ExampleField
impl UnwindSafe for ExampleField
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
-sourceimpl<T, U> Into<U> for T where
U: From<T>,
impl<T, U> Into<U> for T where
U: From<T>,
const: unstable · sourcepub fn into(self) -> U
pub fn into(self) -> U
Calls U::from(self).
Struct ubits::examples::full_example::ExampleField
source · pub struct ExampleField(_);Expand description
Optional docstring for my example bit field.
+Implementations§
source§impl ExampleField
impl ExampleField
Constant values describing ExampleField.
sourcepub const BITS: usize = 8usize
pub const BITS: usize = 8usize
Number of bits in an instance of ExampleField.
sourcepub const BYTES: usize = 1usize
pub const BYTES: usize = 1usize
Number of bytes used by an instance of ExampleField.
sourcepub const MAX: u8 = 255u8
pub const MAX: u8 = 255u8
Maximum valid integer for ExampleField.
source§impl ExampleField
impl ExampleField
Constructors for creating instances of ExampleField.
sourcepub fn new(value: u8) -> Self
pub fn new(value: u8) -> Self
Create a new instance of ExampleField from a u8 value.
sourcepub fn zeros() -> Self
pub fn zeros() -> Self
Create a new instance of ExampleField from 0.
sourcepub fn ones() -> Self
pub fn ones() -> Self
Create a new instance of ExampleField from the maximum possible integer value.
sourcepub fn from_binary_str(value: &str) -> Self
pub fn from_binary_str(value: &str) -> Self
Create a new instance of ExampleField from a binary string.
sourcepub fn from_binary_string(value: String) -> Self
pub fn from_binary_string(value: String) -> Self
Create a new instance of ExampleField from a binary string.
source§impl ExampleField
impl ExampleField
Current state of this bitfield.
+source§impl ExampleField
impl ExampleField
Field accessors by index for ExampleField.
sourcepub fn get_index(&self, index: u8) -> bool
pub fn get_index(&self, index: u8) -> bool
Returns the value of the bit at the supplied index as a boolean.
+sourcepub fn clear_index(&mut self, index: u8)
pub fn clear_index(&mut self, index: u8)
Sets the value of the bit at the supplied index to 0.
sourcepub fn toggle_index(&mut self, index: u8)
pub fn toggle_index(&mut self, index: u8)
Flips the value of the bit at the supplied index.
+source§impl ExampleField
impl ExampleField
Named field accessors by ExampleFlags for ExampleField.
sourcepub fn get(&self, flag: ExampleFlags) -> bool
pub fn get(&self, flag: ExampleFlags) -> bool
Returns the value of the bit at the supplied flag as a boolean.
+sourcepub fn set(&mut self, flag: ExampleFlags) -> &mut Self
pub fn set(&mut self, flag: ExampleFlags) -> &mut Self
Sets the value of the bit at the supplied flag to 1.
sourcepub fn clear(&mut self, flag: ExampleFlags) -> &mut Self
pub fn clear(&mut self, flag: ExampleFlags) -> &mut Self
Sets the value of the bit at the supplied flag to 0.
sourcepub fn toggle(&mut self, flag: ExampleFlags) -> &mut Self
pub fn toggle(&mut self, flag: ExampleFlags) -> &mut Self
Flips the value of the bit at the supplied flag.
+source§impl ExampleField
impl ExampleField
Combinators for ExampleField.
sourcepub fn diff(&self, other: Self) -> Self
pub fn diff(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Does not consume self.
sourcepub fn combine(&self, other: Self) -> Self
pub fn combine(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Does not consume self.
sourcepub fn intersect(&self, other: Self) -> Self
pub fn intersect(&self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Does not consume self.
source§impl ExampleField
impl ExampleField
Conversion methods.
+sourcepub fn into_diff(self, other: Self) -> Self
pub fn into_diff(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that do not match. Consumes self.
sourcepub fn into_combined(self, other: Self) -> Self
pub fn into_combined(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on either input. Consumes self.
sourcepub fn into_intersection(self, other: Self) -> Self
pub fn into_intersection(self, other: Self) -> Self
Returns a new ExampleFieldwith ones for flags that were set on both inputs. Consumes self.
Trait Implementations§
source§impl Binary for ExampleField
impl Binary for ExampleField
source§impl BitAnd<ExampleField> for ExampleField
impl BitAnd<ExampleField> for ExampleField
source§impl BitAnd<ExampleFlags> for &ExampleField
impl BitAnd<ExampleFlags> for &ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
& operator.source§impl BitAnd<ExampleFlags> for &mut ExampleField
impl BitAnd<ExampleFlags> for &mut ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
& operator.source§impl BitAnd<ExampleFlags> for ExampleField
impl BitAnd<ExampleFlags> for ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
& operator.source§impl BitAndAssign<ExampleField> for ExampleField
impl BitAndAssign<ExampleField> for ExampleField
source§fn bitand_assign(&mut self, rhs: Self)
fn bitand_assign(&mut self, rhs: Self)
Performs the
&= operation. Read moresource§impl BitAndAssign<ExampleFlags> for ExampleField
impl BitAndAssign<ExampleFlags> for ExampleField
source§fn bitand_assign(&mut self, rhs: ExampleFlags)
fn bitand_assign(&mut self, rhs: ExampleFlags)
Performs the
&= operation. Read moresource§impl BitOr<ExampleField> for ExampleField
impl BitOr<ExampleField> for ExampleField
source§impl BitOr<ExampleFlags> for &ExampleField
impl BitOr<ExampleFlags> for &ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
| operator.source§impl BitOr<ExampleFlags> for &mut ExampleField
impl BitOr<ExampleFlags> for &mut ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
| operator.source§impl BitOr<ExampleFlags> for ExampleField
impl BitOr<ExampleFlags> for ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
| operator.source§impl BitOrAssign<ExampleField> for ExampleField
impl BitOrAssign<ExampleField> for ExampleField
source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
Performs the
|= operation. Read moresource§impl BitOrAssign<ExampleFlags> for ExampleField
impl BitOrAssign<ExampleFlags> for ExampleField
source§fn bitor_assign(&mut self, rhs: ExampleFlags)
fn bitor_assign(&mut self, rhs: ExampleFlags)
Performs the
|= operation. Read moresource§impl BitXor<ExampleField> for ExampleField
impl BitXor<ExampleField> for ExampleField
source§impl BitXor<ExampleFlags> for &ExampleField
impl BitXor<ExampleFlags> for &ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
^ operator.source§impl BitXor<ExampleFlags> for &mut ExampleField
impl BitXor<ExampleFlags> for &mut ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
^ operator.source§impl BitXor<ExampleFlags> for ExampleField
impl BitXor<ExampleFlags> for ExampleField
§type Output = ExampleField
type Output = ExampleField
The resulting type after applying the
^ operator.source§impl BitXorAssign<ExampleField> for ExampleField
impl BitXorAssign<ExampleField> for ExampleField
source§fn bitxor_assign(&mut self, rhs: Self)
fn bitxor_assign(&mut self, rhs: Self)
Performs the
^= operation. Read moresource§impl BitXorAssign<ExampleFlags> for ExampleField
impl BitXorAssign<ExampleFlags> for ExampleField
source§fn bitxor_assign(&mut self, rhs: ExampleFlags)
fn bitxor_assign(&mut self, rhs: ExampleFlags)
Performs the
^= operation. Read moresource§impl Clone for ExampleField
impl Clone for ExampleField
source§fn clone(&self) -> ExampleField
fn clone(&self) -> ExampleField
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for ExampleField
impl Debug for ExampleField
source§impl Default for ExampleField
impl Default for ExampleField
source§impl From<ExampleFlags> for ExampleField
impl From<ExampleFlags> for ExampleField
Returns a field instance from a flag.
+source§fn from(value: ExampleFlags) -> ExampleField
fn from(value: ExampleFlags) -> ExampleField
Converts to this type from the input type.
source§impl From<u8> for ExampleField
impl From<u8> for ExampleField
Returns a field instance from value of its underlying type.
+source§fn from(value: u8) -> ExampleField
fn from(value: u8) -> ExampleField
Converts to this type from the input type.
source§impl PartialEq<ExampleField> for ExampleField
impl PartialEq<ExampleField> for ExampleField
source§fn eq(&self, other: &ExampleField) -> bool
fn eq(&self, other: &ExampleField) -> bool
This method tests for
self and other values to be equal, and is used
+by ==.source§impl PartialOrd<ExampleField> for ExampleField
impl PartialOrd<ExampleField> for ExampleField
source§fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self and other) and is used by the <=
+operator. Read moreimpl Copy for ExampleField
impl StructuralPartialEq for ExampleField
Auto Trait Implementations§
impl RefUnwindSafe for ExampleField
impl Send for ExampleField
impl Sync for ExampleField
impl Unpin for ExampleField
impl UnwindSafe for ExampleField
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
impl<T> BorrowMut<T> for Twhere + T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
-sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
-sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
-From<T> for U chooses to do.
+Expand description
Examples of generated output using different configurations.
+Expand description
Examples of generated output using different configurations.
This module is only compiled with documentation builds and will not be available for import.
-use the bitfield macro to generate a field struct and flag enum.
Modules
-Example of generated output, using only a bit field without a flag enum.
-Example of generated output, using both a bit field and a flag enum.
-use the bitfield macro to generate a field struct and flag enum.
Modules
- Example of generated output, using only a bit field without a flag enum.
- Example of generated output, using both a bit field and a flag enum.
Expand description
+
Expand description
Crate ubits
Supports field widths of 8, 16, 32, 64 and 128 bits.
-bitfield - macro documentation.examples - examples of the output generated by the bitfield macro.bitfield - macro documentation.examples - examples of the output generated by the bitfield macro.
Note: the example module is only complied with documentation builds
and is not available for importing in the wild.
@@ -23,193 +17,194 @@ Usage
Generate a bitfield struct with a flag enum…
(The following examples all use this as a definition.)
-use ubits::bitfield;
-
- bitfield! {
- pub u8 ExampleField
- ExampleFlags {
- 0 : Flag0,
- 1 : Flag1,
- 2 : Flag2,
- 3 : Flag3,
- 4 : Flag4,
- 5 : Flag5,
- 6 : Flag6,
- 7 : Flag7,
+use ubits::bitfield;
+
+ bitfield! {
+ pub u8 ExampleField
+ ExampleFlags {
+ 0 : Flag0,
+ 1 : Flag1,
+ 2 : Flag2,
+ 3 : Flag3,
+ 4 : Flag4,
+ 5 : Flag5,
+ 6 : Flag6,
+ 7 : Flag7,
}
}
Instances
From integer:
-let from_integer = ExampleField(123);
-assert_eq!(ExampleField(123), from_integer);
+let from_integer = ExampleField(123);
+assert_eq!(ExampleField(123), from_integer);
From a binary string:
-let from_binary = ExampleField::from_binary_str("01111011");
-assert_eq!(ExampleField(123), from_binary)
+let from_binary = ExampleField::from_binary_str("01111011");
+assert_eq!(ExampleField(123), from_binary)
Supports field widths of 8, 16, 32, 64 and 128 bits.
-
-
bitfield- macro documentation.
-examples- examples of the output generated by thebitfieldmacro.
+bitfield- macro documentation.
+examples- examples of the output generated by thebitfieldmacro.
Note: the example module is only complied with documentation builds and is not available for importing in the wild.
@@ -23,193 +17,194 @@Usage
Generate a bitfield struct with a flag enum… (The following examples all use this as a definition.)
-use ubits::bitfield;
-
- bitfield! {
- pub u8 ExampleField
- ExampleFlags {
- 0 : Flag0,
- 1 : Flag1,
- 2 : Flag2,
- 3 : Flag3,
- 4 : Flag4,
- 5 : Flag5,
- 6 : Flag6,
- 7 : Flag7,
+use ubits::bitfield;
+
+ bitfield! {
+ pub u8 ExampleField
+ ExampleFlags {
+ 0 : Flag0,
+ 1 : Flag1,
+ 2 : Flag2,
+ 3 : Flag3,
+ 4 : Flag4,
+ 5 : Flag5,
+ 6 : Flag6,
+ 7 : Flag7,
}
}
Instances
From integer:
-let from_integer = ExampleField(123);
-assert_eq!(ExampleField(123), from_integer);
+let from_integer = ExampleField(123);
+assert_eq!(ExampleField(123), from_integer);From a binary string:
-let from_binary = ExampleField::from_binary_str("01111011");
-assert_eq!(ExampleField(123), from_binary)From ones:
-let from_ones = ExampleField::ones();
-assert_eq!("11111111", from_ones.as_binary());
-assert_eq!(255, from_ones.as_integer());From zeros:
-let from_zeros = ExampleField::zeros();
-assert_eq!("00000000", from_zeros.as_binary());
-assert_eq!(0, from_zeros.as_integer());Field Access
Get bit value by field:
-let field = ExampleField::from_binary_str("01010101");
-assert!(field.get(ExampleFlags::Flag0));
-assert!(!field.get(ExampleFlags::Flag1));Get bit value by index:
-let field = ExampleField::from_binary_str("01010101");
-assert!(field.get_index(0));
-assert!(!field.get_index(1));Set bit value by field:
-let mut field = ExampleField::from_binary_str("01010101");
-field.set(ExampleFlags::Flag1);
-field.set(ExampleFlags::Flag3);
-assert_eq!("01011111", field.as_binary());Set bit value by index:
-let mut field = ExampleField::from_binary_str("01010101");
-field.set_index(1);
-field.set_index(3);
-assert_eq!("01011111", field.as_binary());Clear bit value by field:
-let mut field = ExampleField::from_binary_str("01010101");
-field.clear(ExampleFlags::Flag0);
-field.clear(ExampleFlags::Flag2);
-assert_eq!("01010000", field.as_binary());Clear bit value by index:
-let mut field = ExampleField::from_binary_str("01010101");
-field.clear_index(0);
-field.clear_index(2);
-assert_eq!("01010000", field.as_binary());Toggle bit value by field:
-let mut field = ExampleField::from_binary_str("01010101");
-field.toggle(ExampleFlags::Flag0);
-assert_eq!("01010100", field.as_binary());
-field.toggle(ExampleFlags::Flag0);
-assert_eq!("01010101", field.as_binary());Toggle bit value by index:
-let mut field = ExampleField::from_binary_str("01010101");
-field.toggle_index(0);
-assert_eq!("01010100", field.as_binary());
-field.toggle_index(0);
-assert_eq!("01010101", field.as_binary());Named Getters and Setters
Ubits can generate getter and setter methods for zero or more fields, if a name is provided.
-use ubits::bitfield;
- bitfield! {
- pub u8 ExampleField
- ExampleFlags {
- 0 : Flag0 : (field_0), // is_field_0 & set_field_0 & clear_field_0 & toggle_field_0
- 1 : Flag1 : (field_1), // is_field_1 & set_field_1 & clear_field_1 & toggle_field_1
- 2 : Flag2,
- 3 : Flag3,
- 4 : Flag4,
- 5 : Flag5,
- 6 : Flag6,
- 7 : Flag7,
+use ubits::bitfield;
+ bitfield! {
+ pub u8 ExampleField
+ ExampleFlags {
+ 0 : Flag0 : (field_0), // is_field_0 & set_field_0 & clear_field_0 & toggle_field_0
+ 1 : Flag1 : (field_1), // is_field_1 & set_field_1 & clear_field_1 & toggle_field_1
+ 2 : Flag2,
+ 3 : Flag3,
+ 4 : Flag4,
+ 5 : Flag5,
+ 6 : Flag6,
+ 7 : Flag7,
}
}
-let mut field = ExampleField::from_binary_str("01010101");
-assert_eq!(true, field.is_field_0());
-assert_eq!(false, field.is_field_1());
+let mut field = ExampleField::from_binary_str("01010101");
+assert_eq!(true, field.is_field_0());
+assert_eq!(false, field.is_field_1());
-field.set_field_1();
-assert_eq!(true, field.is_field_1());
+field.set_field_1();
+assert_eq!(true, field.is_field_1());
-field.clear_field_1();
-assert_eq!(false, field.is_field_1());
+field.clear_field_1();
+assert_eq!(false, field.is_field_1());
-field.toggle_field_1();
-assert_eq!(true, field.is_field_1());
+field.toggle_field_1();
+assert_eq!(true, field.is_field_1());Combinations
Combine bit fields:
(use into_combined to consume self)
-let mut a = ExampleField::from_binary_str("01010101");
-let b = ExampleField::from_binary_str("10101010");
-assert_eq!("11111111", a.combine(b).as_binary());Get the intersection of two bitfields:
(use into_intersection to consume self)
-let mut a = ExampleField::from_binary_str("11000011");
-let b = ExampleField::from_binary_str("01111110");
-assert_eq!("01000010", a.intersect(b).as_binary());Get the diff of two bitfields:
(use into_diff to consume self)
-let mut a = ExampleField::from_binary_str("11000011");
-let b = ExampleField::from_binary_str("01100110");
-assert_eq!("10100101", a.diff(b).as_binary());Bitwise
Both bit field instances and flags use bitwise operators to change bit values.
-let mut from_zeros = ExampleField::zeros();
-assert_eq!("00000000", from_zeros.as_binary());
+let mut from_zeros = ExampleField::zeros();
+assert_eq!("00000000", from_zeros.as_binary());
-// set bit to 1
-from_zeros |= ExampleFlags::Flag1;
-assert_eq!("00000010", from_zeros.as_binary());
+// set bit to 1
+from_zeros |= ExampleFlags::Flag1;
+assert_eq!("00000010", from_zeros.as_binary());
-// set bit back to 0
-from_zeros &= ExampleFlags::Flag1;
-assert_eq!("00000000", from_zeros.as_binary());
+// set bit back to 0
+from_zeros &= ExampleFlags::Flag1;
+assert_eq!("00000000", from_zeros.as_binary());
-// toggle a bit
-from_zeros ^= ExampleFlags::Flag1;
-assert_eq!("00000010", from_zeros.as_binary());
+// toggle a bit
+from_zeros ^= ExampleFlags::Flag1;
+assert_eq!("00000010", from_zeros.as_binary());
-from_zeros ^= ExampleFlags::Flag1;
-assert_eq!("00000000", from_zeros.as_binary());Operations can also be chained together:
-let mut from_zeros = ExampleField::zeros() | ExampleFlags::Flag1 | ExampleFlags::Flag3;
-assert_eq!("00001010", from_zeros.as_binary());
+let mut from_zeros = ExampleField::zeros() | ExampleFlags::Flag1 | ExampleFlags::Flag3;
+assert_eq!("00001010", from_zeros.as_binary());
Bitfield instances can also be created from combining flags:
-let mut from_zeros = ExampleFlags::Flag1 | ExampleFlags::Flag3;
-assert_eq!("00001010", from_zeros.as_binary());
+let mut from_zeros = ExampleFlags::Flag1 | ExampleFlags::Flag3;
+assert_eq!("00001010", from_zeros.as_binary());
Fields named with flags
The generated flags enum allows you to access bits by name.
-The flag has an associated u8 value,
+The flag has an associated u8 value,
which determines the index its target bit.
-(See bitfield for more info)
bitfield for more info)
With the following input…
-1 0 1 0 0 1 1 01 0 1 0 0 1 1 0
+and the following flags…
0 : f1
1 : f1
@@ -218,7 +213,8 @@ Fields named
4 : f4
5 : f5
6 : f6
-7 : f7
we end up with this layout.