This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 754fc0d Publishing from 42139971336b9a79a7a0aff310587d155a33faa9
754fc0d is described below
commit 754fc0d092ef8a73f10cbad05f9650834e0e7c0c
Author: Apache Daffodil Site Autobuild <[email protected]>
AuthorDate: Fri May 31 16:29:57 2024 +0000
Publishing from 42139971336b9a79a7a0aff310587d155a33faa9
---
content/layers/index.html | 27 ++++++++++++++++++---------
1 file changed, 18 insertions(+), 9 deletions(-)
diff --git a/content/layers/index.html b/content/layers/index.html
index 79e6685..16a2099 100644
--- a/content/layers/index.html
+++ b/content/layers/index.html
@@ -650,24 +650,33 @@ for the boundary mark string.</p>
</ul>
</li>
<li>Namespace URI: urn:org.apache.daffodil.layers.byteSwap</li>
- <li>Parameter Variables: None</li>
+ <li>Parameter Variables:
+ <ul>
+ <li><code class="language-plaintext
highlighter-rouge">requireLengthInWholeWords</code> - an <code
class="language-plaintext highlighter-rouge">xs:string</code> which can be
"yes" or "no". Defaults to "no".
+Indicates whether it is a processing error if the layer length turns out to
not be a
+multiple of the word size. If bound to a string other than "yes" or "no" it is
a Schema Definition
+Error.</li>
+ </ul>
+ </li>
<li>Result Variables: None</li>
</ul>
-<p>Layer that re-orders bytes according to the word size which is 2 for <code
class="language-plaintext highlighter-rouge">twobyteswap</code> and 4 for
+<p>Layers that re-order bytes according to the word size which is 2 for <code
class="language-plaintext highlighter-rouge">twobyteswap</code> and 4 for
<code class="language-plaintext highlighter-rouge">fourbyteswap</code>
respectively.
-This layer implements streaming behavior.
-It does not require buffering up the data.
-So it can be used on very large data objects.
+These layers implement streaming behavior, meaning they do not require
buffering up the data;
+hence, they can be used on very large data objects.
Bytes within the wrapped input stream are re-ordered <em>word size</em> bytes
at a time.</p>
-<p>For example, if
+<p>For example, with the <code class="language-plaintext
highlighter-rouge">requireLengthInWholeWords</code> as "no" (the default), if
the wrapped input stream contains 10 bytes and word size is 4, then the bytes
from the wrapped
-input stream are returned in the order 4 3 2 1 8 7 6 5 10 9.</p>
-
-<p>If wordsize were 2 then the bytes from the wrapped input stream are
returned in the
+input stream are returned in the order 4 3 2 1 8 7 6 5 10 9. Note that the
last 4-byte word is
+incomplete, but the 2 available bytes are re-ordered anyway.
+If wordsize were 2 then the bytes from the wrapped input stream are returned
in the
order 2 1 4 3 6 5 8 7 10 9.</p>
+<p>If <code class="language-plaintext
highlighter-rouge">requireLengthInWholeWords</code> is bound to "yes", then if
the length is not a multiple of the
+word size a processing error occurs.</p>
+
<hr />
<h3 id="fixedlength-layer">FixedLength Layer</h3>
