| <!DOCTYPE HTML> |
| <html lang="en" class="sidebar-visible no-js light"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>Write a Sanity Test - The bindgen User Guide</title> |
| |
| |
| |
| |
| <!-- Custom HTML head --> |
| |
| |
| |
| <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> |
| <meta name="description" content="`bindgen` automatically generates Rust FFI bindings to C and C++ libraries."> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="theme-color" content="#ffffff" /> |
| |
| |
| <link rel="icon" href="favicon.svg"> |
| |
| |
| <link rel="shortcut icon" href="favicon.png"> |
| |
| <link rel="stylesheet" href="css/variables.css"> |
| <link rel="stylesheet" href="css/general.css"> |
| <link rel="stylesheet" href="css/chrome.css"> |
| |
| <link rel="stylesheet" href="css/print.css" media="print"> |
| |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> |
| |
| <link rel="stylesheet" href="fonts/fonts.css"> |
| |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" href="highlight.css"> |
| <link rel="stylesheet" href="tomorrow-night.css"> |
| <link rel="stylesheet" href="ayu-highlight.css"> |
| |
| <!-- Custom theme stylesheets --> |
| |
| |
| |
| </head> |
| <body> |
| <!-- Provide site root to javascript --> |
| <script type="text/javascript"> |
| var path_to_root = ""; |
| var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; |
| </script> |
| |
| <!-- Work around some values being stored in localStorage wrapped in quotes --> |
| <script type="text/javascript"> |
| try { |
| var theme = localStorage.getItem('mdbook-theme'); |
| var sidebar = localStorage.getItem('mdbook-sidebar'); |
| |
| if (theme.startsWith('"') && theme.endsWith('"')) { |
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); |
| } |
| |
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { |
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); |
| } |
| } catch (e) { } |
| </script> |
| |
| <!-- Set the theme before any content is loaded, prevents flash --> |
| <script type="text/javascript"> |
| var theme; |
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } |
| if (theme === null || theme === undefined) { theme = default_theme; } |
| var html = document.querySelector('html'); |
| html.classList.remove('no-js') |
| html.classList.remove('light') |
| html.classList.add(theme); |
| html.classList.add('js'); |
| </script> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script type="text/javascript"> |
| var html = document.querySelector('html'); |
| var sidebar = 'hidden'; |
| if (document.body.clientWidth >= 1080) { |
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } |
| sidebar = sidebar || 'visible'; |
| } |
| html.classList.remove('sidebar-visible'); |
| html.classList.add("sidebar-" + sidebar); |
| </script> |
| |
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> |
| <div class="sidebar-scrollbox"> |
| <ol class="chapter"><li class="chapter-item expanded "><a href="introduction.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="requirements.html"><strong aria-hidden="true">2.</strong> Requirements</a></li><li class="chapter-item expanded "><a href="library-usage.html"><strong aria-hidden="true">3.</strong> Library Usage with build.rs</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="tutorial-0.html"><strong aria-hidden="true">3.1.</strong> Tutorial</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="tutorial-1.html"><strong aria-hidden="true">3.1.1.</strong> Add bindgen as a Build Dependency</a></li><li class="chapter-item expanded "><a href="tutorial-2.html"><strong aria-hidden="true">3.1.2.</strong> Create a wrapper.h Header</a></li><li class="chapter-item expanded "><a href="tutorial-3.html"><strong aria-hidden="true">3.1.3.</strong> Create a build.rs File</a></li><li class="chapter-item expanded "><a href="tutorial-4.html"><strong aria-hidden="true">3.1.4.</strong> Include the Generated Bindings in src/lib.rs</a></li><li class="chapter-item expanded "><a href="tutorial-5.html" class="active"><strong aria-hidden="true">3.1.5.</strong> Write a Sanity Test</a></li><li class="chapter-item expanded "><a href="tutorial-6.html"><strong aria-hidden="true">3.1.6.</strong> Publish Your Crate!</a></li></ol></li><li class="chapter-item expanded "><a href="non-system-libraries.html"><strong aria-hidden="true">3.2.</strong> Bindings for non-system libraries</a></li></ol></li><li class="chapter-item expanded "><a href="command-line-usage.html"><strong aria-hidden="true">4.</strong> Command Line Usage</a></li><li class="chapter-item expanded "><a href="customizing-generated-bindings.html"><strong aria-hidden="true">5.</strong> Customizing the Generated Bindings</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="allowlisting.html"><strong aria-hidden="true">5.1.</strong> Allowlisting</a></li><li class="chapter-item expanded "><a href="blocklisting.html"><strong aria-hidden="true">5.2.</strong> Blocklisting</a></li><li class="chapter-item expanded "><a href="opaque.html"><strong aria-hidden="true">5.3.</strong> Treating a Type as an Opaque Blob of Bytes</a></li><li class="chapter-item expanded "><a href="replacing-types.html"><strong aria-hidden="true">5.4.</strong> Replacing One Type with Another</a></li><li class="chapter-item expanded "><a href="nocopy.html"><strong aria-hidden="true">5.5.</strong> Preventing the Derivation of Copy and Clone</a></li><li class="chapter-item expanded "><a href="nodebug.html"><strong aria-hidden="true">5.6.</strong> Preventing the Derivation of Debug</a></li><li class="chapter-item expanded "><a href="nodefault.html"><strong aria-hidden="true">5.7.</strong> Preventing the Derivation of Default</a></li><li class="chapter-item expanded "><a href="must-use-types.html"><strong aria-hidden="true">5.8.</strong> Annotating types with #[must-use]</a></li><li class="chapter-item expanded "><a href="visibility.html"><strong aria-hidden="true">5.9.</strong> Field visibility</a></li><li class="chapter-item expanded "><a href="code-formatting.html"><strong aria-hidden="true">5.10.</strong> Code formatting</a></li></ol></li><li class="chapter-item expanded "><a href="cpp.html"><strong aria-hidden="true">6.</strong> Generating Bindings to C++</a></li><li class="chapter-item expanded "><a href="objc.html"><strong aria-hidden="true">7.</strong> Generating Bindings to Objective-c</a></li><li class="chapter-item expanded "><a href="using-unions.html"><strong aria-hidden="true">8.</strong> Using Unions</a></li><li class="chapter-item expanded "><a href="using-bitfields.html"><strong aria-hidden="true">9.</strong> Using Bitfields</a></li><li class="chapter-item expanded "><a href="faq.html"><strong aria-hidden="true">10.</strong> FAQ</a></li></ol> |
| </div> |
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> |
| </nav> |
| |
| <div id="page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| |
| <div id="menu-bar-hover-placeholder"></div> |
| <div id="menu-bar" class="menu-bar sticky bordered"> |
| <div class="left-buttons"> |
| <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> |
| <i class="fa fa-bars"></i> |
| </button> |
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> |
| <i class="fa fa-paint-brush"></i> |
| </button> |
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> |
| </ul> |
| |
| <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> |
| <i class="fa fa-search"></i> |
| </button> |
| |
| </div> |
| |
| <h1 class="menu-title">The bindgen User Guide</h1> |
| |
| <div class="right-buttons"> |
| |
| <a href="print.html" title="Print this book" aria-label="Print this book"> |
| <i id="print-button" class="fa fa-print"></i> |
| </a> |
| |
| |
| <a href="https://github.com/rust-lang/rust-bindgen" title="Git repository" aria-label="Git repository"> |
| <i id="git-repository-button" class="fa fa-github"></i> |
| </a> |
| |
| </div> |
| </div> |
| |
| |
| <div id="search-wrapper" class="hidden"> |
| <form id="searchbar-outer" class="searchbar-outer"> |
| <input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> |
| </form> |
| <div id="searchresults-outer" class="searchresults-outer hidden"> |
| <div id="searchresults-header" class="searchresults-header"></div> |
| <ul id="searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script type="text/javascript"> |
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="content" class="content"> |
| <main> |
| <h1><a class="header" href="#write-a-sanity-test" id="write-a-sanity-test">Write a Sanity Test</a></h1> |
| <p>Finally, to tie everything together, let's write a sanity test that round trips |
| some text through compression and decompression, and then asserts that it came |
| back out the same as it went in. This is a little wordy using the raw FFI |
| bindings, but hopefully we wouldn't usually ask people to do this, we'd provide |
| a nice Rust-y API on top of the raw FFI bindings for them. However, since this |
| is for testing the bindings directly, our sanity test will use the bindings |
| directly.</p> |
| <p>The test data I'm round tripping are some Futurama quotes I got off the internet |
| and put in the <code>futurama-quotes.txt</code> file, which is read into a <code>&'static str</code> |
| at compile time via the <code>include_str!("../futurama-quotes.txt")</code> macro |
| invocation.</p> |
| <p>Without further ado, here is the test, which should be appended to the bottom of |
| our <code>src/lib.rs</code> file:</p> |
| <pre><pre class="playground"><code class="language-rust"> |
| <span class="boring">#![allow(unused)] |
| </span><span class="boring">fn main() { |
| </span>#[cfg(test)] |
| mod tests { |
| use super::*; |
| use std::mem; |
| |
| #[test] |
| fn round_trip_compression_decompression() { |
| unsafe { |
| let input = include_str!("../futurama-quotes.txt").as_bytes(); |
| let mut compressed_output: Vec<u8> = vec![0; input.len()]; |
| let mut decompressed_output: Vec<u8> = vec![0; input.len()]; |
| |
| // Construct a compression stream. |
| let mut stream: bz_stream = mem::zeroed(); |
| let result = BZ2_bzCompressInit(&mut stream as *mut _, |
| 1, // 1 x 100000 block size |
| 4, // verbosity (4 = most verbose) |
| 0); // default work factor |
| match result { |
| r if r == (BZ_CONFIG_ERROR as _) => panic!("BZ_CONFIG_ERROR"), |
| r if r == (BZ_PARAM_ERROR as _) => panic!("BZ_PARAM_ERROR"), |
| r if r == (BZ_MEM_ERROR as _) => panic!("BZ_MEM_ERROR"), |
| r if r == (BZ_OK as _) => {}, |
| r => panic!("Unknown return value = {}", r), |
| } |
| |
| // Compress `input` into `compressed_output`. |
| stream.next_in = input.as_ptr() as *mut _; |
| stream.avail_in = input.len() as _; |
| stream.next_out = compressed_output.as_mut_ptr() as *mut _; |
| stream.avail_out = compressed_output.len() as _; |
| let result = BZ2_bzCompress(&mut stream as *mut _, BZ_FINISH as _); |
| match result { |
| r if r == (BZ_RUN_OK as _) => panic!("BZ_RUN_OK"), |
| r if r == (BZ_FLUSH_OK as _) => panic!("BZ_FLUSH_OK"), |
| r if r == (BZ_FINISH_OK as _) => panic!("BZ_FINISH_OK"), |
| r if r == (BZ_SEQUENCE_ERROR as _) => panic!("BZ_SEQUENCE_ERROR"), |
| r if r == (BZ_STREAM_END as _) => {}, |
| r => panic!("Unknown return value = {}", r), |
| } |
| |
| // Finish the compression stream. |
| let result = BZ2_bzCompressEnd(&mut stream as *mut _); |
| match result { |
| r if r == (BZ_PARAM_ERROR as _) => panic!("BZ_PARAM_ERROR"), |
| r if r == (BZ_OK as _) => {}, |
| r => panic!("Unknown return value = {}", r), |
| } |
| |
| // Construct a decompression stream. |
| let mut stream: bz_stream = mem::zeroed(); |
| let result = BZ2_bzDecompressInit(&mut stream as *mut _, |
| 4, // verbosity (4 = most verbose) |
| 0); // default small factor |
| match result { |
| r if r == (BZ_CONFIG_ERROR as _) => panic!("BZ_CONFIG_ERROR"), |
| r if r == (BZ_PARAM_ERROR as _) => panic!("BZ_PARAM_ERROR"), |
| r if r == (BZ_MEM_ERROR as _) => panic!("BZ_MEM_ERROR"), |
| r if r == (BZ_OK as _) => {}, |
| r => panic!("Unknown return value = {}", r), |
| } |
| |
| // Decompress `compressed_output` into `decompressed_output`. |
| stream.next_in = compressed_output.as_ptr() as *mut _; |
| stream.avail_in = compressed_output.len() as _; |
| stream.next_out = decompressed_output.as_mut_ptr() as *mut _; |
| stream.avail_out = decompressed_output.len() as _; |
| let result = BZ2_bzDecompress(&mut stream as *mut _); |
| match result { |
| r if r == (BZ_PARAM_ERROR as _) => panic!("BZ_PARAM_ERROR"), |
| r if r == (BZ_DATA_ERROR as _) => panic!("BZ_DATA_ERROR"), |
| r if r == (BZ_DATA_ERROR_MAGIC as _) => panic!("BZ_DATA_ERROR"), |
| r if r == (BZ_MEM_ERROR as _) => panic!("BZ_MEM_ERROR"), |
| r if r == (BZ_OK as _) => panic!("BZ_OK"), |
| r if r == (BZ_STREAM_END as _) => {}, |
| r => panic!("Unknown return value = {}", r), |
| } |
| |
| // Close the decompression stream. |
| let result = BZ2_bzDecompressEnd(&mut stream as *mut _); |
| match result { |
| r if r == (BZ_PARAM_ERROR as _) => panic!("BZ_PARAM_ERROR"), |
| r if r == (BZ_OK as _) => {}, |
| r => panic!("Unknown return value = {}", r), |
| } |
| |
| assert_eq!(input, &decompressed_output[..]); |
| } |
| } |
| } |
| <span class="boring">} |
| </span></code></pre></pre> |
| <p>Now let's run <code>cargo test</code> again and verify that everything is linking and binding |
| properly!</p> |
| <pre><code class="language-bash">$ cargo test |
| Compiling bindgen-tutorial-bzip2-sys v0.1.0 |
| Finished debug [unoptimized + debuginfo] target(s) in 0.54 secs |
| Running target/debug/deps/bindgen_tutorial_bzip2_sys-1c5626bbc4401c3a |
| |
| running 15 tests |
| test bindgen_test_layout___darwin_pthread_handler_rec ... ok |
| test bindgen_test_layout___sFILE ... ok |
| test bindgen_test_layout___sbuf ... ok |
| test bindgen_test_layout__bindgen_ty_1 ... ok |
| test bindgen_test_layout__bindgen_ty_2 ... ok |
| test bindgen_test_layout__opaque_pthread_attr_t ... ok |
| test bindgen_test_layout__opaque_pthread_cond_t ... ok |
| test bindgen_test_layout__opaque_pthread_condattr_t ... ok |
| test bindgen_test_layout__opaque_pthread_mutex_t ... ok |
| test bindgen_test_layout__opaque_pthread_mutexattr_t ... ok |
| test bindgen_test_layout__opaque_pthread_once_t ... ok |
| test bindgen_test_layout__opaque_pthread_rwlock_t ... ok |
| test bindgen_test_layout__opaque_pthread_rwlockattr_t ... ok |
| test bindgen_test_layout__opaque_pthread_t ... ok |
| block 1: crc = 0x47bfca17, combined CRC = 0x47bfca17, size = 2857 |
| bucket sorting ... |
| depth 1 has 2849 unresolved strings |
| depth 2 has 2702 unresolved strings |
| depth 4 has 1508 unresolved strings |
| depth 8 has 538 unresolved strings |
| depth 16 has 148 unresolved strings |
| depth 32 has 0 unresolved strings |
| reconstructing block ... |
| 2857 in block, 2221 after MTF & 1-2 coding, 61+2 syms in use |
| initial group 5, [0 .. 1], has 570 syms (25.7%) |
| initial group 4, [2 .. 2], has 256 syms (11.5%) |
| initial group 3, [3 .. 6], has 554 syms (24.9%) |
| initial group 2, [7 .. 12], has 372 syms (16.7%) |
| initial group 1, [13 .. 62], has 469 syms (21.1%) |
| pass 1: size is 2743, grp uses are 13 6 15 0 11 |
| pass 2: size is 1216, grp uses are 13 7 15 0 10 |
| pass 3: size is 1214, grp uses are 13 8 14 0 10 |
| pass 4: size is 1213, grp uses are 13 9 13 0 10 |
| bytes: mapping 19, selectors 17, code lengths 79, codes 1213 |
| final combined CRC = 0x47bfca17 |
| |
| [1: huff+mtf rt+rld {0x47bfca17, 0x47bfca17}] |
| combined CRCs: stored = 0x47bfca17, computed = 0x47bfca17 |
| test tests::round_trip_compression_decompression ... ok |
| |
| test result: ok. 15 passed; 0 failed; 0 ignored; 0 measured |
| |
| Doc-tests bindgen-tutorial-bzip2-sys |
| |
| running 0 tests |
| |
| test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured |
| </code></pre> |
| |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| |
| <a rel="prev" href="tutorial-4.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| |
| |
| <a rel="next" href="tutorial-6.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| |
| <a rel="prev" href="tutorial-4.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| |
| |
| <a rel="next" href="tutorial-6.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| </nav> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| |
| |
| |
| <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script> |
| <script src="mark.min.js" type="text/javascript" charset="utf-8"></script> |
| <script src="searcher.js" type="text/javascript" charset="utf-8"></script> |
| |
| |
| <script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script> |
| <script src="highlight.js" type="text/javascript" charset="utf-8"></script> |
| <script src="book.js" type="text/javascript" charset="utf-8"></script> |
| |
| <!-- Custom JS scripts --> |
| |
| |
| |
| |
| </body> |
| </html> |