Class: Gem::Package::TarReader::Entry (Ruby 2.2.2)
Description: Class : Gem::Package::TarReader::Entry - Ruby 2.2.2

- Home
- Core 2.2.2
- Std-lib 2.2.2
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/package/tar_reader/entry.rb

### Parent

Object

### Methods

- ::new
- #bytes_read
- #close
- #closed?
- #directory?
- #eof?
- #file?
- #full_name
- #getc
- #pos
- #read
- #readpartial
- #rewind

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConfigFile::Psych
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StringSink
- Gem::StringSource
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Package::TarReader::Entry

Class for reading entries out of a tar file

### Attributes

header[R]

Header for this tar entry

### Public Class Methods

new(header, io) click to toggle source

Creates a new tar entry for `header` that will be read from `io`

                   # File rubygems/package/tar_reader/entry.rb, line 19
    def initialize(header, io)
      @closed = false
      @header = header
      @io = io
      @orig_pos = @io.pos
      @read = 0
    end

### Public Instance Methods

bytes_read() click to toggle source

Number of bytes read out of the tar entry

                   # File rubygems/package/tar_reader/entry.rb, line 34
    def bytes_read
      @read
    end

close() click to toggle source

Closes the tar entry

                   # File rubygems/package/tar_reader/entry.rb, line 41
    def close
      @closed = true
    end

closed?() click to toggle source

Is the tar entry closed?

                   # File rubygems/package/tar_reader/entry.rb, line 48
    def closed?
      @closed
    end

directory?() click to toggle source

Is this tar entry a directory?

                   # File rubygems/package/tar_reader/entry.rb, line 93
    def directory?
      @header.typeflag == "5"
    end

eof?() click to toggle source

Are we at the end of the tar entry?

                   # File rubygems/package/tar_reader/entry.rb, line 55
    def eof?
      check_closed

      @read >= @header.size
    end

file?() click to toggle source

Is this tar entry a file?

                   # File rubygems/package/tar_reader/entry.rb, line 100
    def file?
      @header.typeflag == "0"
    end

full_name() click to toggle source

Full name of the tar entry

                   # File rubygems/package/tar_reader/entry.rb, line 64
    def full_name
      if @header.prefix != "" then
        File.join @header.prefix, @header.name
      else
        @header.name
      end
    rescue ArgumentError => e
      raise unless e.message == 'string contains null byte'
      raise Gem::Package::TarInvalidError,
            'tar is corrupt, name contains null byte'
    end

getc() click to toggle source

Read one byte from the tar entry

                   # File rubygems/package/tar_reader/entry.rb, line 79
    def getc
      check_closed

      return nil if @read >= @header.size

      ret = @io.getc
      @read += 1 if ret

      ret
    end

pos() click to toggle source

The position in the tar entry

                   # File rubygems/package/tar_reader/entry.rb, line 107
    def pos
      check_closed

      bytes_read
    end

read(len = nil) click to toggle source

Reads `len` bytes from the tar file entry, or the rest of the entry if nil

                   # File rubygems/package/tar_reader/entry.rb, line 117
    def read(len = nil)
      check_closed

      return nil if @read >= @header.size

      len ||= @header.size - @read
      max_read = [len, @header.size - @read].min

      ret = @io.read max_read
      @read += ret.size

      ret
    end

Also aliased as: readpartial
readpartial(len = nil) click to toggle source
Alias for: read
rewind() click to toggle source

Rewinds to the beginning of the tar file entry

                   # File rubygems/package/tar_reader/entry.rb, line 136
    def rewind
      check_closed

      raise Gem::Package::NonSeekableIO unless @io.respond_to? :pos=

      @io.pos = @orig_pos
      @read = 0
    end