Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,38 +1,38 @@
|
||||
<!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="Allows access to the underlying buffer used by a python object such as `bytes`, `bytearray` or `array.array`."><meta name="keywords" content="rust, rustlang, rust-lang, PyBuffer"><title>pyo3::buffer::PyBuffer - 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">
|
||||
<!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="Allows access to the underlying buffer used by a python object such as `bytes`, `bytearray` or `array.array`."><meta name="keywords" content="rust, rustlang, rust-lang, PyBuffer"><title>PyBuffer in pyo3::buffer - 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 struct"><!--[if lte IE 8]><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><p class="location">Struct PyBuffer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.as_fortran_mut_slice">as_fortran_mut_slice</a><a href="#method.as_fortran_slice">as_fortran_slice</a><a href="#method.as_mut_slice">as_mut_slice</a><a href="#method.as_slice">as_slice</a><a href="#method.buf_ptr">buf_ptr</a><a href="#method.copy_from_fortran_slice">copy_from_fortran_slice</a><a href="#method.copy_from_slice">copy_from_slice</a><a href="#method.copy_to_fortran_slice">copy_to_fortran_slice</a><a href="#method.copy_to_slice">copy_to_slice</a><a href="#method.dimensions">dimensions</a><a href="#method.format">format</a><a href="#method.get">get</a><a href="#method.get_ptr">get_ptr</a><a href="#method.is_c_contiguous">is_c_contiguous</a><a href="#method.is_fortran_contiguous">is_fortran_contiguous</a><a href="#method.item_count">item_count</a><a href="#method.item_size">item_size</a><a href="#method.len_bytes">len_bytes</a><a href="#method.readonly">readonly</a><a href="#method.release">release</a><a href="#method.shape">shape</a><a href="#method.strides">strides</a><a href="#method.suboffsets">suboffsets</a><a href="#method.to_fortran_vec">to_fortran_vec</a><a href="#method.to_vec">to_vec</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Drop">Drop</a><a href="#impl-FromPyObject%3C%27source%3E">FromPyObject<'source></a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">pyo3</a>::<wbr><a href="index.html">buffer</a></p><div id="sidebar-vars" data-name="PyBuffer" data-ty="struct" 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><script src="../../theme.js"></script><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">Struct <a href="../index.html">pyo3</a>::<wbr><a href="index.html">buffer</a>::<wbr><a class="struct" href="">PyBuffer</a></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/buffer.rs.html#31" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct"><span class="docblock attributes top-attr">#[repr(transparent)]</span>pub struct PyBuffer<T>(_, _);</pre></div><div class="docblock"><p>Allows access to the underlying buffer used by a python object such as <code>bytes</code>, <code>bytearray</code> or <code>array.array</code>.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<T: <a class="trait" href="../../pyo3/buffer/trait.Element.html" title="trait pyo3::buffer::Element">Element</a>> <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#169-563" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a>(obj: &<a class="struct" href="../../pyo3/prelude/struct.PyAny.html" title="struct pyo3::prelude::PyAny">PyAny</a>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#171-192" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the underlying buffer from the specified python object.</p>
|
||||
</div><h4 id="method.buf_ptr" class="method"><code>pub fn <a href="#method.buf_ptr" class="fnname">buf_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#199-201" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the pointer to the start of the buffer memory.</p>
|
||||
<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 struct"><!--[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><p class="location">Struct PyBuffer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.as_fortran_mut_slice">as_fortran_mut_slice</a><a href="#method.as_fortran_slice">as_fortran_slice</a><a href="#method.as_mut_slice">as_mut_slice</a><a href="#method.as_slice">as_slice</a><a href="#method.buf_ptr">buf_ptr</a><a href="#method.copy_from_fortran_slice">copy_from_fortran_slice</a><a href="#method.copy_from_slice">copy_from_slice</a><a href="#method.copy_to_fortran_slice">copy_to_fortran_slice</a><a href="#method.copy_to_slice">copy_to_slice</a><a href="#method.dimensions">dimensions</a><a href="#method.format">format</a><a href="#method.get">get</a><a href="#method.get_ptr">get_ptr</a><a href="#method.is_c_contiguous">is_c_contiguous</a><a href="#method.is_fortran_contiguous">is_fortran_contiguous</a><a href="#method.item_count">item_count</a><a href="#method.item_size">item_size</a><a href="#method.len_bytes">len_bytes</a><a href="#method.readonly">readonly</a><a href="#method.release">release</a><a href="#method.shape">shape</a><a href="#method.strides">strides</a><a href="#method.suboffsets">suboffsets</a><a href="#method.to_fortran_vec">to_fortran_vec</a><a href="#method.to_vec">to_vec</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Drop">Drop</a><a href="#impl-FromPyObject%3C%27source%3E">FromPyObject<'source></a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">pyo3</a>::<wbr><a href="index.html">buffer</a></p><div id="sidebar-vars" data-name="PyBuffer" data-ty="struct" 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">Struct <a href="../index.html">pyo3</a>::<wbr><a href="index.html">buffer</a>::<wbr><a class="struct" href="">PyBuffer</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/buffer.rs.html#31" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust struct"><div class="code-attribute">#[repr(transparent)]</div>pub struct PyBuffer<T>(_, _);</pre></div><div class="docblock"><p>Allows access to the underlying buffer used by a python object such as <code>bytes</code>, <code>bytearray</code> or <code>array.array</code>.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl" class="impl"><code class="in-band">impl<T: <a class="trait" href="trait.Element.html" title="trait pyo3::buffer::Element">Element</a>> <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#169-563" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a>(obj: &<a class="struct" href="../prelude/struct.PyAny.html" title="struct pyo3::prelude::PyAny">PyAny</a>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T>></code><a href="#method.get" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#171-192" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the underlying buffer from the specified python object.</p>
|
||||
</div><h4 id="method.buf_ptr" class="method"><code>pub fn <a href="#method.buf_ptr" class="fnname">buf_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a></code><a href="#method.buf_ptr" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#199-201" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the pointer to the start of the buffer memory.</p>
|
||||
<p>Warning: the buffer memory might be mutated by other Python functions,
|
||||
and thus may only be accessed while the GIL is held.</p>
|
||||
</div><h4 id="method.get_ptr" class="method"><code>pub fn <a href="#method.get_ptr" class="fnname">get_ptr</a>(&self, indices: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#206-217" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets a pointer to the specified item.</p>
|
||||
</div><h4 id="method.get_ptr" class="method"><code>pub fn <a href="#method.get_ptr" class="fnname">get_ptr</a>(&self, indices: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a></code><a href="#method.get_ptr" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#206-217" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets a pointer to the specified item.</p>
|
||||
<p>If <code>indices.len() < self.dimensions()</code>, returns the start address of the sub-array at the specified dimension.</p>
|
||||
</div><h4 id="method.readonly" class="method"><code>pub fn <a href="#method.readonly" class="fnname">readonly</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#221-223" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets whether the underlying buffer is read-only.</p>
|
||||
</div><h4 id="method.item_size" class="method"><code>pub fn <a href="#method.item_size" class="fnname">item_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#228-230" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the size of a single element, in bytes.
|
||||
</div><h4 id="method.readonly" class="method"><code>pub fn <a href="#method.readonly" class="fnname">readonly</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a href="#method.readonly" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#221-223" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets whether the underlying buffer is read-only.</p>
|
||||
</div><h4 id="method.item_size" class="method"><code>pub fn <a href="#method.item_size" class="fnname">item_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href="#method.item_size" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#228-230" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the size of a single element, in bytes.
|
||||
Important exception: when requesting an unformatted buffer, item_size still has the value</p>
|
||||
</div><h4 id="method.item_count" class="method"><code>pub fn <a href="#method.item_count" class="fnname">item_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#234-236" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the total number of items.</p>
|
||||
</div><h4 id="method.len_bytes" class="method"><code>pub fn <a href="#method.len_bytes" class="fnname">len_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#242-244" title="goto source code">[src]</a></h4><div class="docblock"><p><code>item_size() * item_count()</code>.
|
||||
</div><h4 id="method.item_count" class="method"><code>pub fn <a href="#method.item_count" class="fnname">item_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href="#method.item_count" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#234-236" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the total number of items.</p>
|
||||
</div><h4 id="method.len_bytes" class="method"><code>pub fn <a href="#method.len_bytes" class="fnname">len_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href="#method.len_bytes" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#242-244" title="goto source code">[src]</a></h4><div class="docblock"><p><code>item_size() * item_count()</code>.
|
||||
For contiguous arrays, this is the length of the underlying memory block.
|
||||
For non-contiguous arrays, it is the length that the logical structure would have if it were copied to a contiguous representation.</p>
|
||||
</div><h4 id="method.dimensions" class="method"><code>pub fn <a href="#method.dimensions" class="fnname">dimensions</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#250-252" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the number of dimensions.</p>
|
||||
</div><h4 id="method.dimensions" class="method"><code>pub fn <a href="#method.dimensions" class="fnname">dimensions</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href="#method.dimensions" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#250-252" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the number of dimensions.</p>
|
||||
<p>May be 0 to indicate a single scalar value.</p>
|
||||
</div><h4 id="method.shape" class="method"><code>pub fn <a href="#method.shape" class="fnname">shape</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#262-264" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns an array of length <code>dimensions</code>. <code>shape()[i]</code> is the length of the array in dimension number <code>i</code>.</p>
|
||||
</div><h4 id="method.shape" class="method"><code>pub fn <a href="#method.shape" class="fnname">shape</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a href="#method.shape" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#262-264" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns an array of length <code>dimensions</code>. <code>shape()[i]</code> is the length of the array in dimension number <code>i</code>.</p>
|
||||
<p>May return None for single-dimensional arrays or scalar values (<code>dimensions() <= 1</code>);
|
||||
You can call <code>item_count()</code> to get the length of the single dimension.</p>
|
||||
<p>Despite Python using an array of signed integers, the values are guaranteed to be non-negative.
|
||||
However, dimensions of length 0 are possible and might need special attention.</p>
|
||||
</div><h4 id="method.strides" class="method"><code>pub fn <a href="#method.strides" class="fnname">strides</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#271-273" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns an array that holds, for each dimension, the number of bytes to skip to get to the next element in the dimension.</p>
|
||||
</div><h4 id="method.strides" class="method"><code>pub fn <a href="#method.strides" class="fnname">strides</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a href="#method.strides" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#271-273" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns an array that holds, for each dimension, the number of bytes to skip to get to the next element in the dimension.</p>
|
||||
<p>Stride values can be any integer. For regular arrays, strides are usually positive,
|
||||
but a consumer MUST be able to handle the case <code>strides[n] <= 0</code>.</p>
|
||||
</div><h4 id="method.suboffsets" class="method"><code>pub fn <a href="#method.suboffsets" class="fnname">suboffsets</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#281-292" title="goto source code">[src]</a></h4><div class="docblock"><p>An array of length ndim.
|
||||
</div><h4 id="method.suboffsets" class="method"><code>pub fn <a href="#method.suboffsets" class="fnname">suboffsets</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a href="#method.suboffsets" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#281-292" title="goto source code">[src]</a></h4><div class="docblock"><p>An array of length ndim.
|
||||
If <code>suboffsets[n] >= 0</code>, the values stored along the nth dimension are pointers and the suboffset value dictates how many bytes to add to each pointer after de-referencing.
|
||||
A suboffset value that is negative indicates that no de-referencing should occur (striding in a contiguous memory block).</p>
|
||||
<p>If all suboffsets are negative (i.e. no de-referencing is needed), then this field must be NULL (the default value).</p>
|
||||
</div><h4 id="method.format" class="method"><code>pub fn <a href="#method.format" class="fnname">format</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CStr.html" title="struct std::ffi::c_str::CStr">CStr</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#296-302" title="goto source code">[src]</a></h4><div class="docblock"><p>A NUL terminated string in struct module style syntax describing the contents of a single item.</p>
|
||||
</div><h4 id="method.is_c_contiguous" class="method"><code>pub fn <a href="#method.is_c_contiguous" class="fnname">is_c_contiguous</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#306-313" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets whether the buffer is contiguous in C-style order (last index varies fastest when visiting items in order of memory address).</p>
|
||||
</div><h4 id="method.is_fortran_contiguous" class="method"><code>pub fn <a href="#method.is_fortran_contiguous" class="fnname">is_fortran_contiguous</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#317-324" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets whether the buffer is contiguous in Fortran-style order (first index varies fastest when visiting items in order of memory address).</p>
|
||||
</div><h4 id="method.as_slice" class="method"><code>pub fn <a href="#method.as_slice" class="fnname">as_slice</a><'a>(&'a self, _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="../../pyo3/buffer/struct.ReadOnlyCell.html" title="struct pyo3::buffer::ReadOnlyCell">ReadOnlyCell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#335-346" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
</div><h4 id="method.format" class="method"><code>pub fn <a href="#method.format" class="fnname">format</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CStr.html" title="struct std::ffi::c_str::CStr">CStr</a></code><a href="#method.format" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#296-302" title="goto source code">[src]</a></h4><div class="docblock"><p>A NUL terminated string in struct module style syntax describing the contents of a single item.</p>
|
||||
</div><h4 id="method.is_c_contiguous" class="method"><code>pub fn <a href="#method.is_c_contiguous" class="fnname">is_c_contiguous</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a href="#method.is_c_contiguous" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#306-313" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets whether the buffer is contiguous in C-style order (last index varies fastest when visiting items in order of memory address).</p>
|
||||
</div><h4 id="method.is_fortran_contiguous" class="method"><code>pub fn <a href="#method.is_fortran_contiguous" class="fnname">is_fortran_contiguous</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a href="#method.is_fortran_contiguous" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#317-324" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets whether the buffer is contiguous in Fortran-style order (first index varies fastest when visiting items in order of memory address).</p>
|
||||
</div><h4 id="method.as_slice" class="method"><code>pub fn <a href="#method.as_slice" class="fnname">as_slice</a><'a>(&'a self, _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="struct.ReadOnlyCell.html" title="struct pyo3::buffer::ReadOnlyCell">ReadOnlyCell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a href="#method.as_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#335-346" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
<p>This function succeeds if:</p>
|
||||
<ul>
|
||||
<li>the buffer format is compatible with <code>T</code></li>
|
||||
@@ -41,7 +41,7 @@ A suboffset value that is negative indicates that no de-referencing should occur
|
||||
</ul>
|
||||
<p>The returned slice uses type <code>Cell<T></code> because it’s theoretically possible for any call into the Python runtime
|
||||
to modify the values in the slice.</p>
|
||||
</div><h4 id="method.as_mut_slice" class="method"><code>pub fn <a href="#method.as_mut_slice" class="fnname">as_mut_slice</a><'a>(&'a self, _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Cell.html" title="struct core::cell::Cell">Cell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#358-369" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
</div><h4 id="method.as_mut_slice" class="method"><code>pub fn <a href="#method.as_mut_slice" class="fnname">as_mut_slice</a><'a>(&'a self, _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Cell.html" title="struct core::cell::Cell">Cell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a href="#method.as_mut_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#358-369" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
<p>This function succeeds if:</p>
|
||||
<ul>
|
||||
<li>the buffer is not read-only</li>
|
||||
@@ -51,7 +51,7 @@ to modify the values in the slice.</p>
|
||||
</ul>
|
||||
<p>The returned slice uses type <code>Cell<T></code> because it’s theoretically possible for any call into the Python runtime
|
||||
to modify the values in the slice.</p>
|
||||
</div><h4 id="method.as_fortran_slice" class="method"><code>pub fn <a href="#method.as_fortran_slice" class="fnname">as_fortran_slice</a><'a>(<br> &'a self, <br> _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="../../pyo3/buffer/struct.ReadOnlyCell.html" title="struct pyo3::buffer::ReadOnlyCell">ReadOnlyCell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#380-391" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
</div><h4 id="method.as_fortran_slice" class="method"><code>pub fn <a href="#method.as_fortran_slice" class="fnname">as_fortran_slice</a><'a>(<br> &'a self, <br> _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="struct.ReadOnlyCell.html" title="struct pyo3::buffer::ReadOnlyCell">ReadOnlyCell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a href="#method.as_fortran_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#380-391" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
<p>This function succeeds if:</p>
|
||||
<ul>
|
||||
<li>the buffer format is compatible with <code>T</code></li>
|
||||
@@ -60,7 +60,7 @@ to modify the values in the slice.</p>
|
||||
</ul>
|
||||
<p>The returned slice uses type <code>Cell<T></code> because it’s theoretically possible for any call into the Python runtime
|
||||
to modify the values in the slice.</p>
|
||||
</div><h4 id="method.as_fortran_mut_slice" class="method"><code>pub fn <a href="#method.as_fortran_mut_slice" class="fnname">as_fortran_mut_slice</a><'a>(<br> &'a self, <br> _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Cell.html" title="struct core::cell::Cell">Cell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#403-414" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
</div><h4 id="method.as_fortran_mut_slice" class="method"><code>pub fn <a href="#method.as_fortran_mut_slice" class="fnname">as_fortran_mut_slice</a><'a>(<br> &'a self, <br> _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Cell.html" title="struct core::cell::Cell">Cell</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code><a href="#method.as_fortran_mut_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#403-414" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the buffer memory as a slice.</p>
|
||||
<p>This function succeeds if:</p>
|
||||
<ul>
|
||||
<li>the buffer is not read-only</li>
|
||||
@@ -70,7 +70,7 @@ to modify the values in the slice.</p>
|
||||
</ul>
|
||||
<p>The returned slice uses type <code>Cell<T></code> because it’s theoretically possible for any call into the Python runtime
|
||||
to modify the values in the slice.</p>
|
||||
</div><h4 id="method.copy_to_slice" class="method"><code>pub fn <a href="#method.copy_to_slice" class="fnname">copy_to_slice</a>(&self, py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#425-427" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to the specified slice.
|
||||
</div><h4 id="method.copy_to_slice" class="method"><code>pub fn <a href="#method.copy_to_slice" class="fnname">copy_to_slice</a>(&self, py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a href="#method.copy_to_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#425-427" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to the specified slice.
|
||||
If the buffer is multi-dimensional, the elements are written in C-style order.</p>
|
||||
<ul>
|
||||
<li>Fails if the slice does not have the correct length (<code>buf.item_count()</code>).</li>
|
||||
@@ -79,7 +79,7 @@ If the buffer is multi-dimensional, the elements are written in C-style order.</
|
||||
<p>To check whether the buffer format is compatible before calling this method,
|
||||
you can use <code><T as buffer::Element>::is_compatible_format(buf.format())</code>.
|
||||
Alternatively, <code>match buffer::ElementType::from_format(buf.format())</code>.</p>
|
||||
</div><h4 id="method.copy_to_fortran_slice" class="method"><code>pub fn <a href="#method.copy_to_fortran_slice" class="fnname">copy_to_fortran_slice</a>(<br> &self, <br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, <br> target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a><br>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#438-440" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to the specified slice.
|
||||
</div><h4 id="method.copy_to_fortran_slice" class="method"><code>pub fn <a href="#method.copy_to_fortran_slice" class="fnname">copy_to_fortran_slice</a>(<br> &self, <br> py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, <br> target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a><br>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a href="#method.copy_to_fortran_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#438-440" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to the specified slice.
|
||||
If the buffer is multi-dimensional, the elements are written in Fortran-style order.</p>
|
||||
<ul>
|
||||
<li>Fails if the slice does not have the correct length (<code>buf.item_count()</code>).</li>
|
||||
@@ -88,13 +88,13 @@ If the buffer is multi-dimensional, the elements are written in Fortran-style or
|
||||
<p>To check whether the buffer format is compatible before calling this method,
|
||||
you can use <code><T as buffer::Element>::is_compatible_format(buf.format())</code>.
|
||||
Alternatively, <code>match buffer::ElementType::from_format(buf.format())</code>.</p>
|
||||
</div><h4 id="method.to_vec" class="method"><code>pub fn <a href="#method.to_vec" class="fnname">to_vec</a>(&self, py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#465-467" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to a newly allocated vector.
|
||||
</div><h4 id="method.to_vec" class="method"><code>pub fn <a href="#method.to_vec" class="fnname">to_vec</a>(&self, py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>></code><a href="#method.to_vec" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#465-467" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to a newly allocated vector.
|
||||
If the buffer is multi-dimensional, the elements are written in C-style order.</p>
|
||||
<p>Fails if the buffer format is not compatible with type <code>T</code>.</p>
|
||||
</div><h4 id="method.to_fortran_vec" class="method"><code>pub fn <a href="#method.to_fortran_vec" class="fnname">to_fortran_vec</a>(&self, py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#473-475" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to a newly allocated vector.
|
||||
</div><h4 id="method.to_fortran_vec" class="method"><code>pub fn <a href="#method.to_fortran_vec" class="fnname">to_fortran_vec</a>(&self, py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>></code><a href="#method.to_fortran_vec" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#473-475" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the buffer elements to a newly allocated vector.
|
||||
If the buffer is multi-dimensional, the elements are written in Fortran-style order.</p>
|
||||
<p>Fails if the buffer format is not compatible with type <code>T</code>.</p>
|
||||
</div><h4 id="method.copy_from_slice" class="method"><code>pub fn <a href="#method.copy_from_slice" class="fnname">copy_from_slice</a>(&self, py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#508-510" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the specified slice into the buffer.
|
||||
</div><h4 id="method.copy_from_slice" class="method"><code>pub fn <a href="#method.copy_from_slice" class="fnname">copy_from_slice</a>(&self, py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a href="#method.copy_from_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#508-510" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the specified slice into the buffer.
|
||||
If the buffer is multi-dimensional, the elements in the slice are expected to be in C-style order.</p>
|
||||
<ul>
|
||||
<li>Fails if the buffer is read-only.</li>
|
||||
@@ -104,7 +104,7 @@ If the buffer is multi-dimensional, the elements in the slice are expected to be
|
||||
<p>To check whether the buffer format is compatible before calling this method,
|
||||
use <code><T as buffer::Element>::is_compatible_format(buf.format())</code>.
|
||||
Alternatively, <code>match buffer::ElementType::from_format(buf.format())</code>.</p>
|
||||
</div><h4 id="method.copy_from_fortran_slice" class="method"><code>pub fn <a href="#method.copy_from_fortran_slice" class="fnname">copy_from_fortran_slice</a>(<br> &self, <br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, <br> source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a><br>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#522-524" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the specified slice into the buffer.
|
||||
</div><h4 id="method.copy_from_fortran_slice" class="method"><code>pub fn <a href="#method.copy_from_fortran_slice" class="fnname">copy_from_fortran_slice</a>(<br> &self, <br> py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, <br> source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a><br>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a href="#method.copy_from_fortran_slice" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#522-524" title="goto source code">[src]</a></h4><div class="docblock"><p>Copies the specified slice into the buffer.
|
||||
If the buffer is multi-dimensional, the elements in the slice are expected to be in Fortran-style order.</p>
|
||||
<ul>
|
||||
<li>Fails if the buffer is read-only.</li>
|
||||
@@ -114,16 +114,16 @@ If the buffer is multi-dimensional, the elements in the slice are expected to be
|
||||
<p>To check whether the buffer format is compatible before calling this method,
|
||||
use <code><T as buffer::Element>::is_compatible_format(buf.format())</code>.
|
||||
Alternatively, <code>match buffer::ElementType::from_format(buf.format())</code>.</p>
|
||||
</div><h4 id="method.release" class="method"><code>pub fn <a href="#method.release" class="fnname">release</a>(self, _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>)</code><a class="srclink" href="../../src/pyo3/buffer.rs.html#548-562" title="goto source code">[src]</a></h4></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Drop" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#572-576" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.drop" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</code><a class="srclink" href="../../src/pyo3/buffer.rs.html#573-575" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></div><h3 id="impl-FromPyObject%3C%27source%3E" class="impl"><code class="in-band">impl<'source, T: <a class="trait" href="../../pyo3/buffer/trait.Element.html" title="trait pyo3::buffer::Element">Element</a>> <a class="trait" href="../../pyo3/conversion/trait.FromPyObject.html" title="trait pyo3::conversion::FromPyObject">FromPyObject</a><'source> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-FromPyObject%3C%27source%3E" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#163-167" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.extract" class="method hidden"><code>fn <a href="../../pyo3/conversion/trait.FromPyObject.html#tymethod.extract" class="fnname">extract</a>(obj: &<a class="struct" href="../../pyo3/prelude/struct.PyAny.html" title="struct pyo3::prelude::PyAny">PyAny</a>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T>></code><a class="srclink" href="../../src/pyo3/buffer.rs.html#164-166" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Extracts <code>Self</code> from the source <code>PyObject</code>.</p>
|
||||
</div></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#35" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#36" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../pyo3/buffer/struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#544-548" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#533-540" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#537" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#581-590" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#587" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#567-576" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#573" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pyo3" data-search-js="../../search-index.js"></div>
|
||||
</div><h4 id="method.release" class="method"><code>pub fn <a href="#method.release" class="fnname">release</a>(self, _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>)</code><a href="#method.release" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#548-562" title="goto source code">[src]</a></h4></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-Drop" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#572-576" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.drop" class="method hidden trait-impl"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</code><a href="#method.drop" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#573-575" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-FromPyObject%3C%27source%3E" class="impl"><code class="in-band">impl<'source, T: <a class="trait" href="trait.Element.html" title="trait pyo3::buffer::Element">Element</a>> <a class="trait" href="../conversion/trait.FromPyObject.html" title="trait pyo3::conversion::FromPyObject">FromPyObject</a><'source> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-FromPyObject%3C%27source%3E" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#163-167" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.extract" class="method hidden trait-impl"><code>fn <a href="../conversion/trait.FromPyObject.html#tymethod.extract" class="fnname">extract</a>(obj: &<a class="struct" href="../prelude/struct.PyAny.html" title="struct pyo3::prelude::PyAny">PyAny</a>) -> <a class="type" href="../prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T>></code><a href="#method.extract" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#164-166" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Extracts <code>Self</code> from the source <code>PyObject</code>.</p>
|
||||
</div></div></details><h3 id="impl-Send" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#35" title="goto source code">[src]</a></h3><h3 id="impl-Sync" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/pyo3/buffer.rs.html#36" title="goto source code">[src]</a></h3></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href="#impl-Unpin" class="anchor"></a></h3><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.PyBuffer.html" title="struct pyo3::buffer::PyBuffer">PyBuffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href="#impl-UnwindSafe" class="anchor"></a></h3></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.type_id" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a href="#method.type_id" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.borrow" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a href="#method.borrow" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a href="#method.borrow_mut" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#544-548" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.from" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a href="#method.from" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#533-540" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.into" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a href="#method.into" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#537" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#581-590" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="associatedtype.Error" class="type trait-impl"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code><a href="#associatedtype.Error" class="anchor"></a></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a href="#method.try_from" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#587" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#567-576" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="associatedtype.Error-1" class="type trait-impl"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code><a href="#associatedtype.Error-1" class="anchor"></a></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden trait-impl"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a href="#method.try_into" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#573" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></details></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>
|
||||
Reference in New Issue
Block a user