{"route":"/en-US-v0.14.1/reference/foundations/bytes/","title":"Bytes","description":"Documentation for the Bytes type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-value","name":"value","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-len","name":"Length","children":[]},{"id":"definitions-at","name":"At","children":[{"id":"definitions-at-index","name":"index","children":[]},{"id":"definitions-at-default","name":"default","children":[]}]},{"id":"definitions-slice","name":"Slice","children":[{"id":"definitions-slice-start","name":"start","children":[]},{"id":"definitions-slice-end","name":"end","children":[]},{"id":"definitions-slice-count","name":"count","children":[]}]}]}],"body":{"kind":"type","content":{"name":"bytes","title":"Bytes","keywords":[],"oneliner":"A sequence of bytes.","details":"

A sequence of bytes.

\n

This is conceptually similar to an array of integers between 0\nand 255, but represented much more efficiently. You can iterate over it\nusing a for loop.

\n

You can convert

\n\n

When reading data from a file, you can decide whether to load it\nas a string or as raw bytes.

\n
#bytes((123, 160, 22, 0)) \\\n#bytes("Hello 😃")\n\n#let data = read(\n  "rhino.png",\n  encoding: none,\n)\n\n// Magic bytes.\n#array(data.slice(0, 4)) \\\n#str(data.slice(1, 4))\n
\"Preview\"
","constructor":{"path":[],"name":"bytes","title":"Construct","keywords":[],"oneliner":"Converts a value to bytes.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts a value to bytes.

\n"},{"kind":"example","content":{"body":"
#bytes("Hello 😃") \\\n#bytes((123, 160, 22, 0))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The value that should be converted to bytes.

"}],"types":["str","bytes","array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bytes"],"scope":[]},"scope":[{"path":["bytes"],"name":"len","title":"Length","keywords":[],"oneliner":"The length in bytes.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

The length in bytes.

"}],"self":true,"params":[],"returns":["int"],"scope":[]},{"path":["bytes"],"name":"at","title":"At","keywords":[],"oneliner":"Returns the byte at the specified index.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the byte at the specified index. Returns the default value if\nthe index is out of bounds or fails with an error if no default value\nwas specified.

"}],"self":true,"params":[{"name":"index","details":[{"kind":"html","content":"

The index at which to retrieve the byte.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"default","details":[{"kind":"html","content":"

A default value to return if the index is out of bounds.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["bytes"],"name":"slice","title":"Slice","keywords":[],"oneliner":"Extracts a subslice of the bytes.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Extracts a subslice of the bytes. Fails with an error if the start or\nend index is out of bounds.

"}],"self":true,"params":[{"name":"start","details":[{"kind":"html","content":"

The start index (inclusive).

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"end","details":[{"kind":"html","content":"

The end index (exclusive). If omitted, the whole slice until the end\nis extracted.

"}],"types":["none","int"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":false},{"name":"count","details":[{"kind":"html","content":"

The number of items to extract. This is equivalent to passing\nstart + count as the end position. Mutually exclusive with\nend.

"}],"types":["int"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["bytes"],"scope":[]}]}}}