2017-07-14 23:24:09 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "generator" content = "rustdoc" >
2017-07-14 23:30:16 +00:00
< meta name = "description" content = "API documentation for the Rust `checked_pow` fn in crate `num_traits`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, checked_pow" >
2017-07-14 23:24:09 +00:00
2017-07-14 23:30:16 +00:00
< title > num_traits::pow::checked_pow - Rust< / title >
2017-07-14 23:24:09 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../normalize.css" >
< link rel = "stylesheet" type = "text/css" href = "../../rustdoc.css" >
< link rel = "stylesheet" type = "text/css" href = "../../main.css" >
2017-07-14 23:30:16 +00:00
< link rel = "shortcut icon" href = "https://rust-num.github.io/num/favicon.ico" >
2017-07-14 23:24:09 +00:00
< / head >
< body class = "rustdoc fn" >
<!-- [if lte IE 8]>
< div class = "warning" >
This old browser is unsupported and will most likely display funky
things.
< / div >
<![endif]-->
< nav class = "sidebar" >
2017-07-14 23:30:16 +00:00
< a href = '../../num_traits/index.html' > < img src = 'https://rust-num.github.io/num/rust-logo-128x128-blk-v2.png' alt = 'logo' width = '100' > < / a >
< p class = 'location' > < a href = '../index.html' > num_traits< / a > ::< wbr > < a href = 'index.html' > pow< / a > < / p > < script > window . sidebarCurrent = { name : 'checked_pow' , ty : 'fn' , relpath : '' } ; < / script > < script defer src = "sidebar-items.js" > < / script >
2017-07-14 23:24:09 +00:00
< / nav >
< nav class = "sub" >
< form class = "search-form js-only" >
< div class = "search-container" >
< input class = "search-input" name = "search"
autocomplete="off"
placeholder="Click or press ‘ ’ ‘ ’
type="search">
< / div >
< / form >
< / nav >
< section id = 'main' class = "content" >
2017-07-14 23:30:16 +00:00
< h1 class = 'fqn' > < span class = 'in-band' > Function < a href = '../index.html' > num_traits< / a > ::< wbr > < a href = 'index.html' > pow< / a > ::< wbr > < a class = "fn" href = '' > checked_pow< / a > < / span > < span class = 'out-of-band' > < span id = 'render-detail' >
2017-07-14 23:24:09 +00:00
< a id = "toggle-all-docs" href = "javascript:void(0)" title = "collapse all docs" >
[< span class = 'inner' > − < / span > ]
< / a >
2017-07-14 23:30:16 +00:00
< / span > < a class = 'srclink' href = '../../src/num_traits/pow.rs.html#49-73' title = 'goto source code' > [src]< / a > < / span > < / h1 >
< pre class = 'rust fn' > pub fn checked_pow< T: < a class = "trait" href = "https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > + < a class = "trait" href = "../../num_traits/identities/trait.One.html" title = "trait num_traits::identities::One" > One< / a > + < a class = "trait" href = "../../num_traits/ops/checked/trait.CheckedMul.html" title = "trait num_traits::ops::checked::CheckedMul" > CheckedMul< / a > > (< br > base: T, < br > exp: < a class = "primitive" href = "https://doc.rust-lang.org/nightly/std/primitive.usize.html" > usize< / a > < br > ) -> < a class = "enum" href = "https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T> < / pre > < div class = 'docblock' > < p > Raises a value to the power of exp, returning < code > None< / code > if an overflow occurred.< / p >
< p > Otherwise same as the < code > pow< / code > function.< / p >
< h1 id = 'example' class = 'section-header' > < a href = '#example' > Example< / a > < / h1 >
< pre class = "rust rust-example-rendered" >
< span class = "kw" > use< / span > < span class = "ident" > num_traits< / span > ::< span class = "ident" > checked_pow< / span > ;
< span class = "macro" > assert_eq< / span > < span class = "macro" > !< / span > (< span class = "ident" > checked_pow< / span > (< span class = "number" > 2i8< / span > , < span class = "number" > 4< / span > ), < span class = "prelude-val" > Some< / span > (< span class = "number" > 16< / span > ));
< span class = "macro" > assert_eq< / span > < span class = "macro" > !< / span > (< span class = "ident" > checked_pow< / span > (< span class = "number" > 7i8< / span > , < span class = "number" > 8< / span > ), < span class = "prelude-val" > None< / span > );
< span class = "macro" > assert_eq< / span > < span class = "macro" > !< / span > (< span class = "ident" > checked_pow< / span > (< span class = "number" > 7u32< / span > , < span class = "number" > 8< / span > ), < span class = "prelude-val" > Some< / span > (< span class = "number" > 5_764_801< / span > ));< a class = "test-arrow" target = "_blank" href = "http://play.integer32.com/?code=extern%20crate%20num_traits%3B%0Afn%20main()%20%7B%0Ause%20num_traits%3A%3Achecked_pow%3B%0A%0Aassert_eq!(checked_pow(2i8%2C%204)%2C%20Some(16))%3B%0Aassert_eq!(checked_pow(7i8%2C%208)%2C%20None)%3B%0Aassert_eq!(checked_pow(7u32%2C%208)%2C%20Some(5_764_801))%3B%0A%7D" > Run< / a > < / pre >
2017-07-14 23:24:09 +00:00
< / div > < / section >
< section id = 'search' class = "content hidden" > < / section >
< section class = "footer" > < / section >
< aside id = "help" class = "hidden" >
< div >
< h1 class = "hidden" > Help< / h1 >
< div class = "shortcuts" >
< h2 > Keyboard Shortcuts< / h2 >
< dl >
< dt > ?< / dt >
< dd > Show this help dialog< / dd >
< dt > S< / dt >
< dd > Focus the search field< / dd >
< dt > ⇤ < / dt >
< dd > Move up in search results< / dd >
< dt > ⇥ < / dt >
< dd > Move down in search results< / dd >
< dt > ⏎ < / dt >
< dd > Go to active search result< / dd >
< dt > +< / dt >
< dd > Collapse/expand all sections< / dd >
< / dl >
< / div >
< div class = "infos" >
< h2 > Search Tricks< / h2 >
< p >
Prefix searches with a type followed by a colon (e.g.
< code > fn:< / code > ) to restrict the search to a given type.
< / p >
< p >
Accepted types are: < code > fn< / code > , < code > mod< / code > ,
< code > struct< / code > , < code > enum< / code > ,
< code > trait< / code > , < code > type< / code > , < code > macro< / code > ,
and < code > const< / code > .
< / p >
< p >
Search functions by type signature (e.g.
< code > vec -> usize< / code > or < code > * -> vec< / code > )
< / p >
< / div >
< / div >
< / aside >
< script >
window.rootPath = "../../";
2017-07-14 23:30:16 +00:00
window.currentCrate = "num_traits";
2017-07-14 23:24:09 +00:00
< / script >
< script src = "../../main.js" > < / script >
< script defer src = "../../search-index.js" > < / script >
< / body >
< / html >
