bionic (3) tcllib_string.3tcl.gz

Provided by: tcllib_1.19-dfsg-2_all bug

NAME
       tcl::chan::string - Read-only in-memory channel


SYNOPSIS
       package require Tcl  8.5

       package require TclOO

       package require tcl::chan::events  ?1?

       package require tcl::chan::string  ?1.0.3?

       ::tcl::chan::string content

________________________________________________________________________________________________________________


DESCRIPTION
       The  tcl::chan::string  package  provides  a  command creating channels which live purely in memory. They
       provide random-access, i.e. are seekable.  In contrast to the channels created by tcl::chan::memchan they
       are read-only however, their content is provided at the time of construction and immutable afterward.

       Packages related to this are tcl::chan::memchan and tcl::chan::variable.

       The  internal  TclOO  class  implementing  the  channel  handler  is a sub-class of the tcl::chan::events
       framework.


API
       ::tcl::chan::string content
              This command creates a new string channel and returns its  handle.  The  channel  provides  random
              read-only access to the content string.


BUGS, IDEAS, FEEDBACK
       This  document,  and  the package it describes, will undoubtedly contain bugs and other problems.  Please
       report such in the category virtchannel of the  Tcllib  Trackers  [http://core.tcl.tk/tcllib/reportlist].
       Please also report any ideas for enhancements you may have for either package and/or documentation.

       When proposing code changes, please provide unified diffs, i.e the output of diff -u.

       Note  further  that  attachments  are strongly preferred over inlined patches. Attachments can be made by
       going to the Edit form of the ticket immediately after its creation, and then using the left-most  button
       in the secondary navigation bar.


KEYWORDS
       in-memory channel, reflected channel, tip 219, virtual channel


CATEGORY
       Channels


       Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>