static/api/python/3.1.x/pulsar.functions.serde.PickleSerDe.html - pulsar-site - Git at Google

 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
           "DTD/xhtml1-strict.dtd">
 <html>


   <head>

     <title>pulsar.functions.serde.PickleSerDe</title>
     <meta name="generator" content="pydoctor 22.9.1">

     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
     <link rel="stylesheet" type="text/css" href="apidocs.css" />
     <link rel="stylesheet" type="text/css" href="readthedocstheme.css" />
     <link rel="stylesheet" type="text/css" href="extra.css" />
 </head>

   <body>


     <nav class="navbar navbar-default mainnavbar">


   <div class="container-fluid">


     <div class="navbar-header">

       <div class="navlinks">
         <span class="navbar-brand">
           pulsar <a href="index.html">API Documentation</a>
         </span>

         <a href="moduleIndex.html">
           Modules
         </a>

         <a href="classIndex.html">
           Classes
         </a>

         <a href="nameIndex.html">
           Names
         </a>

         <div id="search-box-container">
           <div class="input-group">
             <input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />

             <span class="input-group-btn">
               <a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
               <a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
             </span>
           </div>
         </div>

       </div>

     </div>

   </div>


         <!-- Side navigation -->
       <div class="sidebarcontainer">
         <nav class="sidebar">


   <div>

       <div class="thingTitle">
         <span>Class</span>
         <code class="thisobject"><a href="pulsar.functions.serde.PickleSerDe.html" class="internal-link" title="This class"><wbr></wbr>Pickle<wbr></wbr>Ser<wbr></wbr>De</a></code>
       </div>

       <div>


         <div class="childrenKindTitle">Methods</div>
         <ul>

     <li class="">


             <div class="itemName"><code><a href="#deserialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.deserialize">deserialize</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#serialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.serialize">serialize</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div><div>

       <div class="thingTitle">
         <span>Module</span>
         <code><a href="pulsar.functions.serde.html" class="internal-link" title="The parent of this class">serde</a></code>
       </div>

       <div>


         <div class="childrenKindTitle">Classes</div>
         <ul>

     <li class="">


             <div class="itemName"><code><a href="pulsar.functions.serde.IdentitySerDe.html" class="internal-link" title="pulsar.functions.serde.IdentitySerDe"><wbr></wbr>Identity<wbr></wbr>Ser<wbr></wbr>De</a></code>
             </div>


     </li><li class=" thisobject">


             <div class="itemName"><code><a href="pulsar.functions.serde.PickleSerDe.html" class="internal-link" title="pulsar.functions.serde.PickleSerDe"><wbr></wbr>Pickle<wbr></wbr>Ser<wbr></wbr>De</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.functions.serde.SerDe.html" class="internal-link" title="pulsar.functions.serde.SerDe"><wbr></wbr>Ser<wbr></wbr>De</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div>

 </nav>
         <!-- No sidebar toggle for read the docs theme, the sidebar is always
           visible when the screen is width enough.
         -->
       </div>

     </nav>

     <div class="container-fluid">

       <div id="main" class="">


         <div id="search-results-container" style="display: none;">

           <div id="search-buttons">
             <span class="label label-default" id="search-docstrings-button">
             <label class="checkbox-inline">
               <input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
                 search in docstrings
               </input>
             </label>
             </span>

           </div>

           <noscript>
               <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
           </noscript>

           <div class="hint" id="search-help-box">
             <p class="rst-last">

               Search bar offers the following options:
               <ul>
                   <li>
                     <strong>Term presence.</strong> The below example searches for documents that
                       must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
                   </li>

                   <li>
                     <strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
                   </li>

                   <li>
                     <strong>Search in specific fields.</strong> The following search matches all objects
                     in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>

                     <p>
                       Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
                       Last two fields are only applicable if "search in docstrings" is enabled.
                     </p>
                   </li>

                   <li>
                     <strong>Fuzzy matches.</strong> The following search matches all documents
                     that have a word within 1 edit distance of “foo”: <code>foo~1</code>
                   </li>
               </ul>

             </p>
           </div>

           <div id="search-status"> </div>

           <div class="warning" id="search-warn-box" style="display: none;">
             <p class="rst-last"><span id="search-warn"></span></p>
           </div>

           <table id="search-results">
             <!-- Filled dynamically by JS -->
           </table>

           <div style="margin-top: 8px;">
             <p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
           </div>
         </div>

         <div class="page-header">
           <h1 class="class"><code><code><a href="index.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.functions.html" class="internal-link" title="pulsar.functions">functions</a></code><wbr></wbr>.<code><a href="pulsar.functions.serde.html" class="internal-link" title="pulsar.functions.serde">serde</a></code><wbr></wbr>.<code><a href="pulsar.functions.serde.PickleSerDe.html" class="internal-link" title="pulsar.functions.serde.PickleSerDe">PickleSerDe</a></code></code></h1>
           <div id="showPrivate">
             <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
           </div>
         </div>

         <div class="categoryHeader">
           class documentation
         </div>

         <div class="extrasDocstring">
           <p><code><span class="py-keyword">class</span> <span class="py-defname">PickleSerDe</span>(<a href="pulsar.functions.serde.SerDe.html" class="internal-link" title="pulsar.functions.serde.SerDe">SerDe</a>): <a href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/functions/serde.py#L65" class="sourceLink">(source)</a></code></p>
           <p><a href="classIndex.html#pulsar.functions.serde.PickleSerDe">View In Hierarchy</a></p>
         </div>

         <div class="moduleDocstring">
           <div><p>Pickle based serializer</p>
 </div>
         </div>

         <div id="splitTables">
           <table class="children sortable" id="id11">


   <tr class="method">

     <td>Method</td>
     <td><code><a href="#deserialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.deserialize">deserialize</a></code></td>
     <td>Serialize input_bytes into an object</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#serialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.serialize">serialize</a></code></td>
     <td>Serialize input message into bytes</td>
   </tr>
 </table>


         </div>

         <div id="childList">
           <div class="basemethod">


   <a name="pulsar.functions.serde.PickleSerDe.deserialize">

   </a>
   <a name="deserialize">

   </a>
   <div class="functionHeader">

     <span class="py-keyword">def</span> <span class="py-defname">deserialize</span>(self, input_bytes):
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/functions/serde.py#L71">

       (source)
     </a>
     <a class="headerLink" href="#deserialize" title="pulsar.functions.serde.PickleSerDe.deserialize">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">
     <div class="interfaceinfo">overrides <code><a href="pulsar.functions.serde.SerDe.html#deserialize" class="internal-link">pulsar.functions.serde.SerDe.deserialize</a></code></div>
     <div><p>Serialize input_bytes into an object</p>
 </div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.functions.serde.PickleSerDe.serialize">

   </a>
   <a name="serialize">

   </a>
   <div class="functionHeader">

     <span class="py-keyword">def</span> <span class="py-defname">serialize</span>(self, input):
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/functions/serde.py#L68">

       (source)
     </a>
     <a class="headerLink" href="#serialize" title="pulsar.functions.serde.PickleSerDe.serialize">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">
     <div class="interfaceinfo">overrides <code><a href="pulsar.functions.serde.SerDe.html#serialize" class="internal-link">pulsar.functions.serde.SerDe.serialize</a></code></div>
     <div><p>Serialize input message into bytes</p>
 </div>
   </div>
 </div>
         </div>

       </div>
     </div>

     <footer class="navbar navbar-default">
     <hr />


     <div class="container">
       <a href="index.html">API Documentation</a> for pulsar,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
       22.9.1 at 2023-03-14 14:09:17.
     </div>

     <script src="ajax.js" type="text/javascript"></script>
     <script src="searchlib.js" type="text/javascript"></script>
     <script src="search.js" type="text/javascript"></script>

   </footer>

     <script src="pydoctor.js" type="text/javascript"></script>

   </body>
 </html>
	<?xml version="1.0" encoding="utf-8"?>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	"DTD/xhtml1-strict.dtd">
	<html>


	<head>

	<title>pulsar.functions.serde.PickleSerDe</title>
	<meta name="generator" content="pydoctor 22.9.1">

	</meta>
	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
	<link rel="stylesheet" type="text/css" href="apidocs.css" />
	<link rel="stylesheet" type="text/css" href="readthedocstheme.css" />
	<link rel="stylesheet" type="text/css" href="extra.css" />
	</head>

	<body>



	<nav class="navbar navbar-default mainnavbar">


	<div class="container-fluid">


	<div class="navbar-header">

	<div class="navlinks">
	<span class="navbar-brand">
	pulsar <a href="index.html">API Documentation</a>
	</span>

	<a href="moduleIndex.html">
	Modules
	</a>

	<a href="classIndex.html">
	Classes
	</a>

	<a href="nameIndex.html">
	Names
	</a>

	<div id="search-box-container">
	<div class="input-group">
	<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />

	<span class="input-group-btn">
	<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
	<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
	</span>
	</div>
	</div>

	</div>

	</div>

	</div>


	<!-- Side navigation -->
	<div class="sidebarcontainer">
	<nav class="sidebar">


	<div>

	<div class="thingTitle">
	<span>Class</span>
	<code class="thisobject"><a href="pulsar.functions.serde.PickleSerDe.html" class="internal-link" title="This class"><wbr></wbr>Pickle<wbr></wbr>Ser<wbr></wbr>De</a></code>
	</div>

	<div>








	<div class="childrenKindTitle">Methods</div>
	<ul>

	<li class="">





	<div class="itemName"><code><a href="#deserialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.deserialize">deserialize</a></code>
	</div>


	</li><li class="">





	<div class="itemName"><code><a href="#serialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.serialize">serialize</a></code>
	</div>


	</li>
	</ul>










	</div>
	</div><div>

	<div class="thingTitle">
	<span>Module</span>
	<code><a href="pulsar.functions.serde.html" class="internal-link" title="The parent of this class">serde</a></code>
	</div>

	<div>





	<div class="childrenKindTitle">Classes</div>
	<ul>

	<li class="">





	<div class="itemName"><code><a href="pulsar.functions.serde.IdentitySerDe.html" class="internal-link" title="pulsar.functions.serde.IdentitySerDe"><wbr></wbr>Identity<wbr></wbr>Ser<wbr></wbr>De</a></code>
	</div>


	</li><li class=" thisobject">





	<div class="itemName"><code><a href="pulsar.functions.serde.PickleSerDe.html" class="internal-link" title="pulsar.functions.serde.PickleSerDe"><wbr></wbr>Pickle<wbr></wbr>Ser<wbr></wbr>De</a></code>
	</div>


	</li><li class="">





	<div class="itemName"><code><a href="pulsar.functions.serde.SerDe.html" class="internal-link" title="pulsar.functions.serde.SerDe"><wbr></wbr>Ser<wbr></wbr>De</a></code>
	</div>


	</li>
	</ul>













	</div>
	</div>

	</nav>
	<!-- No sidebar toggle for read the docs theme, the sidebar is always
	visible when the screen is width enough.
	-->
	</div>

	</nav>

	<div class="container-fluid">

	<div id="main" class="">




	<div id="search-results-container" style="display: none;">

	<div id="search-buttons">
	<span class="label label-default" id="search-docstrings-button">
	<label class="checkbox-inline">
	<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
	search in docstrings
	</input>
	</label>
	</span>

	</div>

	<noscript>
	<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
	</noscript>

	<div class="hint" id="search-help-box">
	<p class="rst-last">

	Search bar offers the following options:
	<ul>
	<li>
	<strong>Term presence.</strong> The below example searches for documents that
	must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
	</li>

	<li>
	<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
	</li>

	<li>
	<strong>Search in specific fields.</strong> The following search matches all objects
	in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>

	<p>
	Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
	Last two fields are only applicable if "search in docstrings" is enabled.
	</p>
	</li>

	<li>
	<strong>Fuzzy matches.</strong> The following search matches all documents
	that have a word within 1 edit distance of “foo”: <code>foo~1</code>
	</li>
	</ul>

	</p>
	</div>

	<div id="search-status"> </div>

	<div class="warning" id="search-warn-box" style="display: none;">
	<p class="rst-last"><span id="search-warn"></span></p>
	</div>

	<table id="search-results">
	<!-- Filled dynamically by JS -->
	</table>

	<div style="margin-top: 8px;">
	<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
	</div>
	</div>

	<div class="page-header">
	<h1 class="class"><code><code><a href="index.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.functions.html" class="internal-link" title="pulsar.functions">functions</a></code><wbr></wbr>.<code><a href="pulsar.functions.serde.html" class="internal-link" title="pulsar.functions.serde">serde</a></code><wbr></wbr>.<code><a href="pulsar.functions.serde.PickleSerDe.html" class="internal-link" title="pulsar.functions.serde.PickleSerDe">PickleSerDe</a></code></code></h1>
	<div id="showPrivate">
	<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
	</div>
	</div>

	<div class="categoryHeader">
	class documentation
	</div>

	<div class="extrasDocstring">
	<p><code><span class="py-keyword">class</span> <span class="py-defname">PickleSerDe</span>(<a href="pulsar.functions.serde.SerDe.html" class="internal-link" title="pulsar.functions.serde.SerDe">SerDe</a>): <a href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/functions/serde.py#L65" class="sourceLink">(source)</a></code></p>
	<p><a href="classIndex.html#pulsar.functions.serde.PickleSerDe">View In Hierarchy</a></p>
	</div>

	<div class="moduleDocstring">
	<div><p>Pickle based serializer</p>
	</div>
	</div>

	<div id="splitTables">
	<table class="children sortable" id="id11">


	<tr class="method">

	<td>Method</td>
	<td><code><a href="#deserialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.deserialize">deserialize</a></code></td>
	<td>Serialize input_bytes into an object</td>
	</tr><tr class="method">

	<td>Method</td>
	<td><code><a href="#serialize" class="internal-link" title="pulsar.functions.serde.PickleSerDe.serialize">serialize</a></code></td>
	<td>Serialize input message into bytes</td>
	</tr>
	</table>



	</div>

	<div id="childList">
	<div class="basemethod">


	<a name="pulsar.functions.serde.PickleSerDe.deserialize">

	</a>
	<a name="deserialize">

	</a>
	<div class="functionHeader">

	<span class="py-keyword">def</span> <span class="py-defname">deserialize</span>(self, input_bytes):
	<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/functions/serde.py#L71">

	(source)
	</a>
	<a class="headerLink" href="#deserialize" title="pulsar.functions.serde.PickleSerDe.deserialize">


	¶
	</a>
	</div>
	<div class="docstring functionBody">
	<div class="interfaceinfo">overrides <code><a href="pulsar.functions.serde.SerDe.html#deserialize" class="internal-link">pulsar.functions.serde.SerDe.deserialize</a></code></div>
	<div><p>Serialize input_bytes into an object</p>
	</div>
	</div>
	</div><div class="basemethod">


	<a name="pulsar.functions.serde.PickleSerDe.serialize">

	</a>
	<a name="serialize">

	</a>
	<div class="functionHeader">

	<span class="py-keyword">def</span> <span class="py-defname">serialize</span>(self, input):
	<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/functions/serde.py#L68">

	(source)
	</a>
	<a class="headerLink" href="#serialize" title="pulsar.functions.serde.PickleSerDe.serialize">


	¶
	</a>
	</div>
	<div class="docstring functionBody">
	<div class="interfaceinfo">overrides <code><a href="pulsar.functions.serde.SerDe.html#serialize" class="internal-link">pulsar.functions.serde.SerDe.serialize</a></code></div>
	<div><p>Serialize input message into bytes</p>
	</div>
	</div>
	</div>
	</div>

	</div>
	</div>

	<footer class="navbar navbar-default">
	<hr />


	<div class="container">
	<a href="index.html">API Documentation</a> for pulsar,
	generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
	22.9.1 at 2023-03-14 14:09:17.
	</div>

	<script src="ajax.js" type="text/javascript"></script>
	<script src="searchlib.js" type="text/javascript"></script>
	<script src="search.js" type="text/javascript"></script>

	</footer>

	<script src="pydoctor.js" type="text/javascript"></script>

	</body>
	</html>