<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.stream.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'class.streambucket.php',
    1 => 'StreamBucket',
    2 => 'The StreamBucket class',
  ),
  'up' => 
  array (
    0 => 'book.stream.php',
    1 => 'Streams',
  ),
  'prev' => 
  array (
    0 => 'streamwrapper.url-stat.php',
    1 => 'streamWrapper::url_stat',
  ),
  'next' => 
  array (
    0 => 'ref.stream.php',
    1 => 'Stream Functions',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/stream/streambucket.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.streambucket" class="reference">

 <h1 class="title">The StreamBucket class</h1>
 

 <div class="partintro"><p class="verinfo">(PHP 8 &gt;= 8.4.0)</p>

  <div class="section" id="streambucket.intro">
   <h2 class="title">Introduction</h2>
   <p class="simpara">
    A stream bucket is a chunk of a stream which can be extracted from bucket brigades.
   </p>
  </div>

  <div class="section" id="streambucket.synopsis">
   <h2 class="title">Class synopsis</h2>

   <div class="classsynopsis"><div class="classsynopsisinfo">
    
     <span class="modifier">final</span>
     <span class="modifier">class</span> <strong class="classname"><strong class="classname">StreamBucket</strong></strong>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
     <span class="modifier">readonly</span>
     <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>
      <var class="varname"><a href="class.streambucket.php#streambucket.props.bucket">$<var class="varname">bucket</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="modifier">readonly</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="varname"><a href="class.streambucket.php#streambucket.props.data">$<var class="varname">data</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="modifier">readonly</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="varname"><a href="class.streambucket.php#streambucket.props.datalen">$<var class="varname">datalen</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="modifier">readonly</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="varname"><a href="class.streambucket.php#streambucket.props.datalength">$<var class="varname">dataLength</var></a></var>;</div>

   }</div>
  </div>

  <div class="section" id="streambucket.props">
   <h2 class="title">Properties</h2>
   <dl>
    
     <dt id="streambucket.props.bucket">resource <var class="varname">bucket</var></dt>
     <dd>
      <span class="simpara">A <code class="literal">userfilter.bucket</code> resource.</span>
     </dd>
    
    
     <dt id="streambucket.props.data">string <var class="varname">data</var></dt>
     <dd>
      <span class="simpara">The current string in the bucket.</span>
     </dd>
    
    
     <dt id="streambucket.props.datalen">int <var class="varname">datalen</var></dt>
     <dd>
      <span class="simpara">
       The length of the string in the bucket.
       Deprecated as of PHP 8.4 in favor of <code class="literal">StreamBucket::$dataLength</code>.
      </span>
     </dd>
    
    
     <dt id="streambucket.props.datalength">int <var class="varname">dataLength</var></dt>
     <dd>
      <span class="simpara">The length of the string in the bucket.</span>
     </dd>
    
   </dl>
  </div>

  <div class="section">
   <h2 class="title">See Also</h2>
   <ul class="simplelist">
    <li><span class="function"><a href="function.stream-bucket-new.php" class="function">stream_bucket_new()</a></span></li>
    <li><span class="function"><a href="function.stream-bucket-append.php" class="function">stream_bucket_append()</a></span></li>
    <li><span class="function"><a href="function.stream-bucket-prepend.php" class="function">stream_bucket_prepend()</a></span></li>
    <li><span class="function"><a href="function.stream-bucket-make-writeable.php" class="function">stream_bucket_make_writeable()</a></span></li>
   </ul>
  </div>

 </div>

</div>
<?php manual_footer($setup); ?>