Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

FileStyle Class Reference

Inheritance diagram for FileStyle:

ConduitStyle List of all members.

Public Types

enum  Open { Exists = 0, Create, Truncate, Append }
enum  Share { Read = 0, Write, ReadWrite }
enum  Cache { None = 0x00, Random = 0x01, Stream = 0x02, WriteThru = 0x04 }

Public Member Functions

 this (Access access, Open open=Open.Exists, Share share=Share.Read, Cache cache=Cache.None)
Open open ()
Share share ()
Cache cache ()

Static Public Member Functions

 this ()

Static Public Attributes

FileStyle ReadExisting
FileStyle WriteTruncate
FileStyle WriteAppending
FileStyle ReadWriteCreate
FileStyle ReadWriteExisting

Private Types

enum  Access { Read = 0x01, Write = 0x02, ReadWrite = 0x03 }

Private Member Functions

 this (Access access)
Access access ()

Private Attributes

Open m_open
Share m_share
Cache m_cache

Detailed Description

Defines how a file should be opened. You can use the predefined instances, or create specializations for your own needs.

Definition at line 47 of file FileStyle.d.


Member Enumeration Documentation

enum Open
 

Enumeration values:
Exists 
Create 
Truncate 
Append 

Definition at line 65 of file FileStyle.d.

Referenced by FileConduit::VersionWin32::_open(), open(), and this().

enum Share
 

Enumeration values:
Read  Expose common instances of ConduitStyle
Write  Expose common instances of ConduitStyle
ReadWrite  Expose common instances of ConduitStyle

Definition at line 76 of file FileStyle.d.

Referenced by share(), and this().

enum Cache
 

Enumeration values:
None 
Random 
Stream 
WriteThru 

Definition at line 86 of file FileStyle.d.

Referenced by cache(), and this().

enum Access [inherited]
 

Declare the basic styles for a Conduit

Enumeration values:
Read 
Write 
ReadWrite 

Definition at line 54 of file ConduitStyle.d.

Referenced by ConduitStyle::access(), and ConduitStyle::this().


Member Function Documentation

this  )  [inline, static]
 

Construct a set of typical FileStyle instances.

Reimplemented from ConduitStyle.

Definition at line 107 of file FileStyle.d.

References FileStyle, Open, ReadExisting, ReadWriteCreate, ReadWriteExisting, WriteAppending, and WriteTruncate.

this Access  access,
Open  open = Open.Exists,
Share  share = Share.Read,
Cache  cache = Cache.None
[inline]
 

Construct a FileStyle with the given properties. Defaults are set to indicate the file should exist, will be opened for read-only sharing, and should not be cache optimized in any special manner by the OS.

Definition at line 125 of file FileStyle.d.

References Cache, m_cache, m_open, m_share, Open, share(), and Share.

Open open  )  [inline]
 

Return the style of opening

Definition at line 142 of file FileStyle.d.

References m_open, and Open.

Referenced by FileConduit::Versionlinux::_open(), and FileConduit::VersionWin32::_open().

Share share  )  [inline]
 

Return the style of sharing

Definition at line 153 of file FileStyle.d.

References m_share, and Share.

Referenced by FileConduit::Versionlinux::_open(), FileConduit::VersionWin32::_open(), and this().

Cache cache  )  [inline]
 

Return the style of caching

Definition at line 164 of file FileStyle.d.

References Cache, and m_cache.

Referenced by FileConduit::VersionWin32::_open().

this Access  access  )  [inline, inherited]
 

Construct a ConduitStyle with the given access

Definition at line 91 of file ConduitStyle.d.

References ConduitStyle::access(), ConduitStyle::Access, and ConduitStyle::m_access.

Access access  )  [inline, inherited]
 

Return the access attribute of this ConduitStyle

Definition at line 102 of file ConduitStyle.d.

References ConduitStyle::Access, and ConduitStyle::m_access.

Referenced by FileConduit::Versionlinux::_open(), FileConduit::VersionWin32::_open(), Conduit::isReadable(), Conduit::isWritable(), FileConduit::VersionWin32::Win32MappedBuffer::this(), and ConduitStyle::this().


Member Data Documentation

FileStyle ReadExisting [static]
 

Instantiate some common styles

Definition at line 55 of file FileStyle.d.

Referenced by this().

FileStyle WriteTruncate [static]
 

Instantiate some common styles

Definition at line 55 of file FileStyle.d.

Referenced by this().

FileStyle WriteAppending [static]
 

Instantiate some common styles

Definition at line 55 of file FileStyle.d.

Referenced by this().

FileStyle ReadWriteCreate [static]
 

Instantiate some common styles

Definition at line 55 of file FileStyle.d.

Referenced by this().

FileStyle ReadWriteExisting [static]
 

Instantiate some common styles

Definition at line 55 of file FileStyle.d.

Referenced by this().

Open m_open [private]
 

Definition at line 97 of file FileStyle.d.

Referenced by open(), and this().

Share m_share [private]
 

Definition at line 98 of file FileStyle.d.

Referenced by share(), and this().

Cache m_cache [private]
 

Definition at line 99 of file FileStyle.d.

Referenced by cache(), and this().


The documentation for this class was generated from the following file:
Generated on Sun Nov 7 19:07:02 2004 for Mango by doxygen 1.3.6