github-actions[bot]
18 lines
5.7 KiB
HTML
18 lines
5.7 KiB
HTML
<!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"><meta name="description" content="Serialize an object to bytes using the Python built-in marshal module."><meta name="keywords" content="rust, rustlang, rust-lang, dumps"><title>dumps in pyo3::marshal - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../pyo3/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="../index.html">pyo3</a>::<wbr><a href="index.html">marshal</a></p><div id="sidebar-vars" data-name="dumps" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">pyo3</a>::<wbr><a href="index.html">marshal</a>::<wbr><a class="fn" href="">dumps</a><button id="copy-path" onclick="copy_path(this)">⎘</button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/pyo3/marshal.rs.html#34-39" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn dumps<'a>(<br> py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a>, <br> object: &impl <a class="trait" href="../conversion/trait.AsPyPointer.html" title="trait pyo3::conversion::AsPyPointer">AsPyPointer</a>, <br> version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><br>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><&'a <a class="struct" href="../types/struct.PyBytes.html" title="struct pyo3::types::PyBytes">PyBytes</a>></pre><div class="docblock"><p>Serialize an object to bytes using the Python built-in marshal module.</p>
|
||
<p>The built-in marshalling only supports a limited range of objects.
|
||
The exact types supported depend on the version argument.
|
||
The <a href="constant.VERSION.html" title="VERSION"><code>VERSION</code></a> constant holds the highest version currently supported.</p>
|
||
<p>See the <a href="https://docs.python.org/3/library/marshal.html">Python documentation</a> for more details.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example:</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">dict</span> <span class="op">=</span> <span class="ident">PyDict::new</span>(<span class="ident">py</span>);
|
||
<span class="ident">dict</span>.<span class="ident">set_item</span>(<span class="string">"aap"</span>, <span class="string">"noot"</span>).<span class="ident">unwrap</span>();
|
||
<span class="ident">dict</span>.<span class="ident">set_item</span>(<span class="string">"mies"</span>, <span class="string">"wim"</span>).<span class="ident">unwrap</span>();
|
||
<span class="ident">dict</span>.<span class="ident">set_item</span>(<span class="string">"zus"</span>, <span class="string">"jet"</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="ident">marshal::dumps</span>(<span class="ident">py</span>, <span class="ident">dict</span>, <span class="ident">marshal::VERSION</span>);</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pyo3" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
|
||
<script src="../../main.js"></script></body></html> |