wyfilestat.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH WyFileStat 3wy "libwy v0.31"
.SH NAME
WyFileStat \- class of file status 
.SH SYNOPSIS
.B #include <wyfilestat.h>
.PP
WyFileStat is a discardable class for \fBstruct stat\fP, the system
file information.
.SH "PUBLIC MEMBERS"
 \fBWyFileStat\fP() throw() 
 \fBWyFileStat\fP(const WyFileStat&) throw()
 \fBWyFileStat\fP(WyFileStat&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 mode_t \fBsf_mode\fP(void) const throw()
 ino_t \fBsf_ino\fP(void) const throw()
 dev_t \fBsf_dev\fP(void) const throw()
 nlink_t \fBsf_nlink\fP(void) const throw()
 uid_t \fBsf_uid\fP(void) const throw()
 gid_t \fBsf_gid\fP(void) const throw()
 dev_t \fBsf_rdev\fP(void) const throw()
 off_t \fBsf_size\fP(void) const throw()
 blksize_t \fBsf_blksize\fP(void) const throw()
 blkcnt_t \fBsf_blocks\fP(void) const throw()
 std::time_t \fBsf_atime\fP(void) const throw()
 std::time_t \fBsf_ctime\fP(void) const throw()
 std::time_t \fBsf_mtime\fP(void) const throw()
 void \fBreset\fP(void) throw()
 void \fBreset\fP(const WyFileStat&) throw()
 void \fBswap\fP(WyFileStat&) throw()
 const WyFileStat& \fBoperator =\fP(const WyFileStat&) throw()
 bool \fBis_dir\fP(void) const throw()
 bool \fBis_chr\fP(void) const throw()
 bool \fBis_blk\fP(void) const throw()
 bool \fBis_reg\fP(void) const throw()
 bool \fBis_fifo\fP(void) const throw() 
 bool \fBis_lnk\fP(void) const throw()
 bool \fBis_sock\fP(void) const throw()
 bool \fBoperator\fP ==(const WyFileStat&) const throw()
 bool \fBoperator\fP !=(const WyFileStat&) const throw()
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "WyFileStat() throw()"
.PP
    Construct default object

     sf_mode()   = mode_t()
     sf_ino()    = ino_t()
     sf_dev()    = dev_t()
     sf_nlink()  = nlink_t()
     sf_uid()    = uid_t()
     sf_gid()    = gid_t()
     sf_rdev()   = dev_t()
     sf_size()   = off_t()
     sf_blksize()= blksize_t()
     sf_blocks() = blkcnt_t()
     sf_atime()  = std::time_t()
     sf_ctime()  = std::time_t()
     sf_mtime()  = std::time_t()

     See stat(2) for struct stat
.\"--------------------------------------------
.PP
.BI "WyFileStat(const WyFileStat& " "stt" ") throw()"
.PP
    Construct object by copy from \fIstt\fP

     sf_mode()   = copy from \fIstt\fP
     sf_ino()    = ditto 
     sf_dev()    = ditto
     sf_nlink()  = ditto
     sf_uid()    = ditto
     sf_gid()    = ditto
     sf_rdev()   = ditto
     sf_size()   = ditto
     sf_blksize()= ditto
     sf_blocks() = ditto
     sf_atime()  = ditto
     sf_ctime()  = ditto
     sf_mtime()  = ditto

     See stat(2) for struct stat
.\"--------------------------------------------
.PP
.BI "WyFileStat(WyFileStat& " "src" ", Wy::ByMove_t) throw()"
.PP
    See Wy_Array(Wy_Array&, Wy::ByMove_t) in wy_array(3wy)
    for definition of the move constructor.
.\"--------------------------------------------
.PP
.BI "bool is_default(void) const throw()"
.PP
    Is *this equivalent to the default object
.PP
    [\fBRet\fP] true= object is equivalent to WyFileStat()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "mode_t sf_mode(void) const throw()
.PP
    Get file mode
.PP 
    [\fBRet\fP] Bit-wise OR'd value:
         S_IRWYU   Mask for file owner permission
         S_IRUSR   Owner read permission
         S_IWUSR   Owner write permission
         S_IXUSR   Owner execute permission
    
         S_IRWYG   Mask for group permission
         S_IRGRP   Group read permission
         S_IWGRP   Group write permission
         S_IXGRP   Group execute permission
    
         S_IRWYO   Mask for others
         S_IROTH   Others read permission
         S_IWOTH   Others write permission
         S_IXOTH   Others execute permission
    
         S_ISUID   Set user ID on execution
         S_ISGID   Set group ID on execution
.PP 
    [\fBRefer\fP] st_mode (struct stat)
.\"--------------------------------------------
.PP
.BI "ino_t sf_ino(void) const throw()"
.PP
    Get the file serial number
.PP 
    [\fBRet\fP] File serial number
.PP 
    [\fBRefer\fP] st_ino (struct stat)
.\"--------------------------------------------
.PP
.BI "dev_t sf_dev(void) const throw()"
.PP
    Get the device identifier of the file
.PP 
    [\fBRet\fP] Device identifier of the file
.PP 
    [\fBRefer\fP] st_dev (struct stat)
.\"--------------------------------------------
.PP
.BI "nlink_t sf_nlink(void) const throw()"
.PP
    Get the number of links
.PP 
    [\fBRet\fP] Number of links
.PP 
    [\fBRefer\fP] st_nlink (struct stat)
.\"--------------------------------------------
.PP
.BI "uid_t sf_uid(void) const throw()"
.PP
    Get the user identifier
.PP 
    [\fBRet\fP] User identifier
.PP 
    [\fBRefer\fP] st_uid (struct stat)
.\"--------------------------------------------
.PP
.BI "gid_t sf_gid(void) const throw()"
.PP
    Get the group identifier
.PP 
    [\fBRet\fP] Group identifier
.PP 
    [\fBRefer\fP] st_gid (struct stat)
.\"--------------------------------------------
.PP
.BI "dev_t sf_rdev(void) const throw()"
.PP
    Get the device type
.PP 
    [\fBRet\fP] Device type
.PP 
    [\fBRefer\fP] st_rdev (struct stat)
.\"--------------------------------------------
.PP
.BI "off_t sf_size(void) const throw()"
.PP
    Get the file size (only for a regular file)
.PP 
    [\fBRet\fP] File size in bytes
.PP 
    [\fBRefer\fP] st_size (struct stat)
.\"--------------------------------------------
.PP
.BI "blksize_t sf_blksize(void) const throw()"
.PP
    Get the blocksize for filesystem I/O
.PP 
    [\fBRet\fP] The preferred fileblocks for efficient I/O
.PP 
    [\fBRefer\fP] st_blksize (struct stat)
.\"--------------------------------------------
.PP
.BI "blkcnt_t sf_blocks(void) const throw()"
.PP
    Get the size of the file in blocks (e.g. size()/512)
.PP 
    [\fBRet\fP] Number of blocks the file allocated
.PP 
    [\fBRefer\fP] st_blocks (struct stat)
.\"--------------------------------------------
.PP
.BI "std::time_t sf_atime(void) const throw()"
.PP
    Get the time of last access
.PP 
    [\fBRet\fP] Time of last access (UTC seconds)
.PP 
    [\fBRefer\fP] st_atime (struct stat)
.\"--------------------------------------------
.PP
.BI "std::time_t sf_ctime(void) const throw()"
.PP
    Get the time of last change (permission,owner,group)
.PP 
    [\fBRet\fP] Time of last change (UTC seconds)
.PP 
    [\fBRefer\fP] st_ctime (struct stat)
.\"--------------------------------------------
.PP
.BI "std::time_t sf_mtime(void) const throw()"
.PP
    Get the time of last modification
.PP 
    [\fBRet\fP] Time of last modification (UTC seconds)
.PP 
    [\fBRefer\fP] st_mtime (struct stat)
.\"--------------------------------------------
.PP
.BI "void reset(void) throw()"
.PP
    Reconstruct *this to the state as WyFileStat()
.\"--------------------------------------------
.PP
.BI "void reset(const WyFileStat& " "stt" ") throw()"
.PP
    Reconstruct *this to the state as WyFileStat(\fIstt\fP)
.\"--------------------------------------------
.PP
.BI "void swap(WyFileStat& " "stt" ") throw()"
.PP
    Interchange state of *this with \fIstt\fP
.\"--------------------------------------------
.PP
.BI "const WyFileStat& operator =(const WyFileStat& " "stt" ") throw()"
.PP
    Assign *this to the state as WyFileStat(\fIstt\fP)
.PP
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "bool is_dir(void) const throw()"
.PP
    Is object referring to a directory

    This member is equivalent to S_ISDIR(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a directory
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool is_chr(void) const throw()"
.PP
    Is object referring to a character special file

    This member is equivalent to S_ISCHR(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a character special file
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool is_blk(void) const throw()"
.PP
    Is object referring to a block special file

    This member is equivalent to S_ISBLK(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a block special file
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool is_reg(void) const throw()"
.PP
    Is object referring to a regular file

    This member is equivalent to S_ISREG(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a regular file
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool is_fifo(void) const throw()"
.PP
    Is object referring to a FIFO file

    This member is equivalent to S_ISFIFO(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a FIFO file
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool is_lnk(void) const throw()"
.PP
    Is object referring to a link file

    This member is equivalent to S_ISLNK(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a link file
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool is_sock(void) const throw()"
.PP
    Is object referring to a socket

    This member is equivalent to S_ISSOCK(sf_mode())
.PP 
    [\fBRet\fP] true= object refers to a socket
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const WyFileStat& " "stt" ") const throw()"
.PP
.BI "bool operator !=(const WyFileStat& " "stt" ") const throw()"
.PP 
    Test equivalence of *this with \fIstt\fP

    this->operator==(\fIstt\fP) yields true iff for all other
    const members \fBf\fP, this->\fBf\fP()==\fIstt\fP.\fBf\fP()
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.SH "SEE ALSO"
.BR stat(2)
.BR wyret
.BR wytimespec
.BR wy_dirfile
.BR wychrfile
.BR wyregfile
.SH NOTE
Project is in development, http://sourceforge.net/projects/libwx