lispdoc - results for flexi-stream

flexi-streams:octet
Type: A shortcut for (UNSIGNED-BYTE 8).
  
(flexi-streams:peek-byte flexi-input-stream &optional peek-type (eof-error-p)
 eof-value)
Undocumented
  
(flexi-streams:char-length sequence &key (external-format latin1) (start 0)
 (end (length sequence)))
Function: Kind of the inverse of OCTET-LENGTH. Returns the length of the subsequence (of octets) of SEQUENCE from START to END in characters if decoded using the external format EXTERNAL-FORMAT. Note that this function doesn't check for the validity of the data in SEQUENCE. This function is optimized for the case of SEQUENCE being a vector. Don't use lists if you're in a hurry.
  
(flexi-streams:unread-byte byte flexi-input-stream)
Undocumented
  
flexi-streams:list-stream
Type: A LIST-STREAM is a mixin for IN-MEMORY streams where the underlying sequence is a list.
  
(flexi-streams:octet-length string &key (external-format latin1) (start 0)
 (end (length string)))
Function: Returns the length of the substring of STRING from START to END in octets if encoded using the external format EXTERNAL-FORMAT. In spite of the name, STRING can be any sequence of characters, but the function is optimized for strings.
  
flexi-streams:flexi-stream
Type: A FLEXI-STREAM object is a stream that's `layered' atop an existing binary/bivalent stream in order to allow for multi-octet external formats. FLEXI-STREAM itself is a mixin and should not be instantiated.
  
flexi-streams:vector-stream
Type: A VECTOR-STREAM is a mixin for IN-MEMORY streams where the underlying sequence is a vector.
  
flexi-streams:*substitution-char*
Variable: If this value is not NIL, it should be a character which is used (as if by a USE-VALUE restart) whenever during reading an error of type FLEXI-STREAM-ENCODING-ERROR would have been signalled otherwise.
  
flexi-streams:flexi-io-stream
Type: A FLEXI-IO-STREAM is a FLEXI-STREAM that can actually be instatiated and used for input and output. Don't use MAKE-INSTANCE to create a new FLEXI-IO-STREAM but use MAKE-FLEXI-STREAM instead.
  
(flexi-streams:octets-to-string sequence &key (external-format latin1)
 (start 0) (end (length sequence)))
Function: Converts the Lisp sequence SEQUENCE of octets from START to END to a string using the external format designated by EXTERNAL-FORMAT. This function is optimized for the case of SEQUENCE being a vector. Don't use lists if you're in a hurry.
  
flexi-streams:in-memory-stream
Type: An IN-MEMORY-STREAM is a binary stream that reads octets from or writes octets to a sequence in RAM.
  
(flexi-streams:string-to-octets string &key (external-format latin1) (start 0)
 (end (length string)))
Function: Converts the Lisp string STRING from START to END to an array of octets corresponding to the external format designated by EXTERNAL-FORMAT. In spite of the name, STRING can be any sequence of characters, but the function is optimized for strings.
  
(flexi-streams:make-flexi-stream stream &rest args &key
 (external-format (make-external-format iso-8859-1)) element-type column
 position bound)
Function: Creates and returns a new flexi stream. STREAM must be an open binary or `bivalent' stream, i.e. it must be capable of reading/writing octets with READ-SEQUENCE and/or WRITE-SEQUENCE. The resulting flexi stream is an input stream if and only if STREAM is an input stream. Likewise, it's an output stream if and only if STREAM is an output stream. The default for ELEMENT-TYPE is LW:SIMPLE-CHAR on LispWorks and CHARACTER on other Lisps. EXTERNAL-FORMAT must be an EXTERNAL-FORMAT object or a symbol or a list denoting such an object. COLUMN is the initial column of the stream which is either a non-negative integer or NIL. The COLUMN argument must only be used for output streams. POSITION (only used for input streams) should be an integer and it denotes the position the stream is in - it will be increased by one for each octet read. BOUND (only used for input streams) should be NIL or an integer. If BOUND is not NIL and POSITION has gone beyond BOUND, then the stream will behave as if no more input is available.
  
flexi-streams:flexi-stream-error
Type: Superclass for all errors related to flexi streams.
Structure: Superclass for all errors related to flexi streams.
  
(flexi-streams:flexi-stream-bound object)
Undocumented
  
(flexi-streams:external-format-id object)
Undocumented
  
flexi-streams:flexi-input-stream
Type: A FLEXI-INPUT-STREAM is a FLEXI-STREAM that can actually be instatiated and used for input. Don't use MAKE-INSTANCE to create a new FLEXI-INPUT-STREAM but use MAKE-FLEXI-STREAM instead.
  
(flexi-streams:flexi-stream-stream object)
Undocumented
  
flexi-streams:flexi-output-stream
Type: A FLEXI-OUTPUT-STREAM is a FLEXI-STREAM that can actually be instatiated and used for output. Don't use MAKE-INSTANCE to create a new FLEXI-OUTPUT-STREAM but use MAKE-FLEXI-STREAM instead.
  
flexi-streams:*default-eol-style*
Variable: The end-of-line style used by external formats if none is explicitly given. Depends on the OS the code is compiled on.
  
(flexi-streams:flexi-stream-column object)
Undocumented
  
(flexi-streams:make-external-format name &rest args &key
 (little-endian *default-little-endian*) id eol-style)
Function: Creates and returns an external format object as specified. NAME is a keyword like :LATIN1 or :UTF-8, LITTLE-ENDIAN specifies the `endianess' of the external format and is ignored for 8-bit encodings, EOL-STYLE is one of the keywords :CR, :LF, or :CRLF which denote the end-of-line character (sequence), ID is the ID of a Windows code page (and ignored for other encodings).
  
(flexi-streams:external-format-name object)
Undocumented
  
flexi-streams:external-format-error
Type: Superclass for all errors related to external formats.
Structure: Superclass for all errors related to external formats.
  
(flexi-streams:flexi-stream-position object)
Undocumented
  
(flexi-streams:external-format-equal ef1 ef2)
Function: Checks whether two EXTERNAL-FORMAT objects denote the same encoding.
  
flexi-streams:*default-little-endian*
Variable: Whether external formats are little-endian by default (i.e. unless explicitly specified). Depends on the platform the code is compiled on.
  
flexi-streams:accept-overlong-sequence
Undocumented
  
flexi-streams:external-format-condition
Type: Superclass for all conditions related to external formats.
Structure: Superclass for all conditions related to external formats.
  
flexi-streams:in-memory-stream-error
Type: Superclass for all errors related to IN-MEMORY streams.
Structure: Superclass for all errors related to IN-MEMORY streams.
  
flexi-streams:in-memory-input-stream
Type: An IN-MEMORY-INPUT-STREAM is a binary stream that reads octets from a sequence in RAM.
  
flexi-streams:in-memory-output-stream
Type: An IN-MEMORY-OUTPUT-STREAM is a binary stream that writes octets to a sequence in RAM.
  
(flexi-streams:with-output-to-sequence
 (var &key as-list (element-type ''octet) transformer) &body body)
Function: Creates an IN-MEMORY output stream, binds VAR to this stream and then executes the code in BODY. The stream stores data of type ELEMENT-TYPE (a subtype of OCTET) which is (optionally) transformed by the function TRANSFORMER prior to storage. The stream is automatically closed on exit from WITH-OUTPUT-TO-SEQUENCE, no matter whether the exit is normal or abnormal. The return value of this macro is a vector (or a list if AS-LIST is true) containing the octets that were sent to the stream within BODY.
  
(flexi-streams:with-input-from-sequence
 (var sequence &key start end transformer) &body body)
Function: Creates an IN-MEMORY input stream from SEQUENCE using the parameters START and END, binds VAR to this stream and then executes the code in BODY. A function TRANSFORMER may optionally be specified to transform the returned octets. The stream is automatically closed on exit from WITH-INPUT-FROM-SEQUENCE, no matter whether the exit is normal or abnormal. The return value of this macro is the return value of BODY.
  
(flexi-streams:flexi-stream-element-type object)
Undocumented
  
(flexi-streams:external-format-eol-style object)
Undocumented
  
(flexi-streams:get-output-stream-sequence stream &key as-list)
Undocumented
  
(flexi-streams:flexi-stream-external-format object)
Undocumented
  
(flexi-streams:external-format-little-endian object)
Undocumented
  
(flexi-streams:output-stream-sequence-length stream)
Undocumented
  
flexi-streams:external-format-encoding-error
Type: Errors of this type are signalled if there is an encoding problem.
Structure: Errors of this type are signalled if there is an encoding problem.
  
(flexi-streams:make-in-memory-input-stream vector &key transformer
 (end (length vector)) (start 0))
Undocumented
  
(flexi-streams:make-in-memory-output-stream &key (element-type 'octet)
 transformer)
Function: Returns a binary output stream which accepts objects of type ELEMENT-TYPE (a subtype of OCTET) and makes available a sequence that contains the octes that were actually output. The octets stored will each be transformed by the optional TRANSFORMER function.
  
flexi-streams:in-memory-stream-closed-error
Type: An error that is signalled when someone is trying to read from or write to a closed IN-MEMORY stream.
Structure: An error that is signalled when someone is trying to read from or write to a closed IN-MEMORY stream.
  
flexi-streams:flexi-stream-element-type-error
Type: Errors of this type are signalled if the flexi stream has a wrong element type.
Structure: Errors of this type are signalled if the flexi stream has a wrong element type.
  
flexi-streams:flexi-stream-out-of-sync-error
Type: This can happen if you're trying to write to an IO stream which had prior to that `looked ahead' while reading and now can't `rewind' to the octet where you /should/ be.
Structure: This can happen if you're trying to write to an IO stream which had prior to that `looked ahead' while reading and now can't `rewind' to the octet where you /should/ be.
  
(flexi-streams:external-format-condition-external-format condition)
Undocumented
  
flexi-streams:in-memory-stream-position-spec-error
Type: Errors of this type are signalled if an erroneous position spec is used in conjunction with FILE-POSITION.
Structure: Errors of this type are signalled if an erroneous position spec is used in conjunction with FILE-POSITION.
  
(flexi-streams:flexi-stream-element-type-error-element-type condition)
Undocumented
  
(flexi-streams:in-memory-stream-position-spec-error-position-spec condition)
Undocumented