files.com 1.1.813 → 1.1.814
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/doc/Files/APIConnectionError.html +1 -1
- data/doc/Files/APIError.html +1 -1
- data/doc/Files/AccountAlreadyExistsError.html +1 -1
- data/doc/Files/AccountLineItem.html +1 -1
- data/doc/Files/AccountOverdueError.html +1 -1
- data/doc/Files/Action.html +1 -1
- data/doc/Files/ActionLog.html +1 -1
- data/doc/Files/ActionNotificationExport.html +1 -1
- data/doc/Files/ActionNotificationExportResult.html +1 -1
- data/doc/Files/AdditionalAuthenticationRequiredError.html +1 -1
- data/doc/Files/AgentNode.html +1 -1
- data/doc/Files/AgentNodeConnection.html +1 -1
- data/doc/Files/AgentNodeInstance.html +1 -1
- data/doc/Files/AgentPushUpdate.html +1 -1
- data/doc/Files/AgentPushUpdateBlockedError.html +1 -1
- data/doc/Files/AgentUnavailableError.html +1 -1
- data/doc/Files/AgentUpgradeRequiredError.html +1 -1
- data/doc/Files/AiAssistantPersonality.html +1 -1
- data/doc/Files/AiTask.html +1 -1
- data/doc/Files/AiTaskCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AlreadyCompletedError.html +1 -1
- data/doc/Files/Api.html +20 -13
- data/doc/Files/ApiClient/RequestLogContext.html +29 -29
- data/doc/Files/ApiClient/TransferSettings.html +721 -0
- data/doc/Files/ApiClient.html +756 -204
- data/doc/Files/ApiKey.html +1 -1
- data/doc/Files/ApiKeyIsDisabledError.html +1 -1
- data/doc/Files/ApiKeyIsPathRestrictedError.html +1 -1
- data/doc/Files/ApiKeyNotFoundError.html +1 -1
- data/doc/Files/ApiKeyOnlyForDesktopAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForFileOperationsError.html +1 -1
- data/doc/Files/ApiKeyOnlyForMobileAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForOfficeIntegrationError.html +1 -1
- data/doc/Files/ApiKeySessionsNotSupportedError.html +1 -1
- data/doc/Files/ApiRequestLog.html +1 -1
- data/doc/Files/App.html +1 -1
- data/doc/Files/As2IncomingMessage.html +1 -1
- data/doc/Files/As2OutgoingMessage.html +1 -1
- data/doc/Files/As2Partner.html +1 -1
- data/doc/Files/As2Station.html +1 -1
- data/doc/Files/AttachmentTooLargeError.html +1 -1
- data/doc/Files/AuthenticationError.html +1 -1
- data/doc/Files/AuthenticationRequiredError.html +1 -1
- data/doc/Files/Auto.html +1 -1
- data/doc/Files/Automation.html +1 -1
- data/doc/Files/AutomationAuthoringSchema.html +1 -1
- data/doc/Files/AutomationCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AutomationExecutionNode.html +1 -1
- data/doc/Files/AutomationLog.html +1 -1
- data/doc/Files/AutomationRun.html +1 -1
- data/doc/Files/AutomationsUnavailableError.html +1 -1
- data/doc/Files/BadRequestError.html +1 -1
- data/doc/Files/BandwidthSnapshot.html +1 -1
- data/doc/Files/Behavior.html +1 -1
- data/doc/Files/BehaviorNotAllowedOnRemoteServerError.html +1 -1
- data/doc/Files/BillingInformationHiddenError.html +1 -1
- data/doc/Files/BillingPermissionRequiredError.html +1 -1
- data/doc/Files/BufferedUploadDisabledForThisDestinationError.html +1 -1
- data/doc/Files/Bundle.html +1 -1
- data/doc/Files/BundleAction.html +1 -1
- data/doc/Files/BundleDownload.html +1 -1
- data/doc/Files/BundleMaximumUsesReachedError.html +1 -1
- data/doc/Files/BundleNotification.html +1 -1
- data/doc/Files/BundleOnlyAllowsPreviewsError.html +1 -1
- data/doc/Files/BundleOperationRequiresSubfolderError.html +1 -1
- data/doc/Files/BundlePath.html +1 -1
- data/doc/Files/BundlePathNotFoundError.html +1 -1
- data/doc/Files/BundlePermissionRequiredError.html +1 -1
- data/doc/Files/BundleRecipient.html +1 -1
- data/doc/Files/BundleRegistration.html +1 -1
- data/doc/Files/BundleRegistrationCodeFailedError.html +1 -1
- data/doc/Files/BundleRegistrationNotFoundError.html +1 -1
- data/doc/Files/CannotAdministerHigherLevelUserError.html +1 -1
- data/doc/Files/CannotDownloadDirectoryError.html +1 -1
- data/doc/Files/CannotLoginWhileUsingKeyError.html +1 -1
- data/doc/Files/CantActForOtherUserError.html +1 -1
- data/doc/Files/CantMoveWithMultipleLocationsError.html +1 -1
- data/doc/Files/ChatMessage.html +1 -1
- data/doc/Files/ChatSession.html +1 -1
- data/doc/Files/ChildSiteManagementPolicy.html +1 -1
- data/doc/Files/Clickwrap.html +1 -1
- data/doc/Files/CodeNotFoundError.html +1 -1
- data/doc/Files/ConfigurationLockedPathError.html +1 -1
- data/doc/Files/ContactAdminForPasswordChangeHelpError.html +1 -1
- data/doc/Files/CouldNotCreateParentError.html +1 -1
- data/doc/Files/CustomDomain.html +1 -1
- data/doc/Files/DatetimeParseError.html +1 -1
- data/doc/Files/DesktopConfigurationProfile.html +1 -1
- data/doc/Files/DestinationExistsError.html +1 -1
- data/doc/Files/DestinationFolderLimitedError.html +1 -1
- data/doc/Files/DestinationParentConflictError.html +1 -1
- data/doc/Files/DestinationParentDoesNotExistError.html +1 -1
- data/doc/Files/DestinationSameError.html +1 -1
- data/doc/Files/DestinationSiteMismatchError.html +1 -1
- data/doc/Files/DirectConnectionInfo.html +1 -1
- data/doc/Files/DnsRecord.html +1 -1
- data/doc/Files/DoesNotSupportSortingError.html +1 -1
- data/doc/Files/DuplicateShareRecipientError.html +1 -1
- data/doc/Files/EmailIncomingMessage.html +1 -1
- data/doc/Files/EmailLog.html +1 -1
- data/doc/Files/Error.html +2 -2
- data/doc/Files/Errors.html +1 -1
- data/doc/Files/EventChannel.html +1 -1
- data/doc/Files/EventDeliveryAttempt.html +1 -1
- data/doc/Files/EventRecord.html +1 -1
- data/doc/Files/EventSubscription.html +1 -1
- data/doc/Files/EventTarget.html +1 -1
- data/doc/Files/ExavaultApiRequestLog.html +1 -1
- data/doc/Files/ExceededRuntimeLimitError.html +1 -1
- data/doc/Files/Expectation.html +1 -1
- data/doc/Files/ExpectationAlreadyHasOpenWindowError.html +1 -1
- data/doc/Files/ExpectationEvaluation.html +1 -1
- data/doc/Files/ExpectationIncident.html +1 -1
- data/doc/Files/ExpectationNotManualTriggerError.html +1 -1
- data/doc/Files/ExpiredPrivateKeyError.html +1 -1
- data/doc/Files/ExpiredPublicKeyError.html +1 -1
- data/doc/Files/ExportFailureError.html +1 -1
- data/doc/Files/ExportNotReadyError.html +1 -1
- data/doc/Files/ExternalEvent.html +1 -1
- data/doc/Files/FailedToChangePasswordError.html +1 -1
- data/doc/Files/File.html +2019 -1515
- data/doc/Files/FileAction.html +1 -1
- data/doc/Files/FileActionError.html +1 -1
- data/doc/Files/FileComment.html +1 -1
- data/doc/Files/FileCommentReaction.html +1 -1
- data/doc/Files/FileLockedError.html +1 -1
- data/doc/Files/FileMigration.html +1 -1
- data/doc/Files/FileMigrationLog.html +1 -1
- data/doc/Files/FileNotFoundError.html +1 -1
- data/doc/Files/FileNotUploadedError.html +1 -1
- data/doc/Files/FilePendingProcessingError.html +1 -1
- data/doc/Files/FileProcessingErrorError.html +1 -1
- data/doc/Files/FileTooBigToDecryptError.html +1 -1
- data/doc/Files/FileTooBigToEncryptError.html +1 -1
- data/doc/Files/FileUploadNotFoundError.html +1 -1
- data/doc/Files/FileUploadPart.html +1 -1
- data/doc/Files/FileUploadedToWrongRegionError.html +1 -1
- data/doc/Files/FileUtils.html +1 -1
- data/doc/Files/FilenameTooLongError.html +1 -1
- data/doc/Files/FilesAgentFailedAuthorizationError.html +1 -1
- data/doc/Files/FilesNativeStorageOverloadedError.html +1 -1
- data/doc/Files/Folder.html +1 -1
- data/doc/Files/FolderAdminOrBillingPermissionRequiredError.html +1 -1
- data/doc/Files/FolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/FolderLockedError.html +1 -1
- data/doc/Files/FolderMustNotBeAFileError.html +1 -1
- data/doc/Files/FolderNotEmptyError.html +1 -1
- data/doc/Files/FoldersNotAllowedError.html +1 -1
- data/doc/Files/FormField.html +1 -1
- data/doc/Files/FormFieldSet.html +1 -1
- data/doc/Files/FtpActionLog.html +1 -1
- data/doc/Files/FullPermissionRequiredError.html +1 -1
- data/doc/Files/GpgKey.html +1 -1
- data/doc/Files/Group.html +1 -1
- data/doc/Files/GroupNotFoundError.html +1 -1
- data/doc/Files/GroupUser.html +1 -1
- data/doc/Files/History.html +1 -1
- data/doc/Files/HistoryExport.html +1 -1
- data/doc/Files/HistoryExportResult.html +1 -1
- data/doc/Files/HistoryPermissionRequiredError.html +1 -1
- data/doc/Files/HistoryUnavailableError.html +1 -1
- data/doc/Files/HolidayCalendar.html +1 -1
- data/doc/Files/HolidayRegion.html +1 -1
- data/doc/Files/Image.html +1 -1
- data/doc/Files/InAppAiAssistantUnavailableError.html +1 -1
- data/doc/Files/InboundS3Log.html +1 -1
- data/doc/Files/InboxNotFoundError.html +1 -1
- data/doc/Files/InboxRecipient.html +1 -1
- data/doc/Files/InboxRegistration.html +1 -1
- data/doc/Files/InboxRegistrationCodeFailedError.html +1 -1
- data/doc/Files/InboxUpload.html +1 -1
- data/doc/Files/InsufficientPermissionForParamsError.html +1 -1
- data/doc/Files/InsufficientPermissionForSiteError.html +1 -1
- data/doc/Files/IntegrationCentricProfile.html +1 -1
- data/doc/Files/InternalGeneralErrorError.html +1 -1
- data/doc/Files/InvalidBodyError.html +1 -1
- data/doc/Files/InvalidBundleCodeError.html +1 -1
- data/doc/Files/InvalidCredentialsError.html +1 -1
- data/doc/Files/InvalidCursorError.html +1 -1
- data/doc/Files/InvalidCursorTypeForSortError.html +1 -1
- data/doc/Files/InvalidEtagsError.html +1 -1
- data/doc/Files/InvalidFileTypeError.html +1 -1
- data/doc/Files/InvalidFilenameError.html +1 -1
- data/doc/Files/InvalidFilterAliasCombinationError.html +1 -1
- data/doc/Files/InvalidFilterFieldError.html +1 -1
- data/doc/Files/InvalidFilterParamError.html +1 -1
- data/doc/Files/InvalidFilterParamFormatError.html +1 -1
- data/doc/Files/InvalidFilterParamValueError.html +1 -1
- data/doc/Files/InvalidInputEncodingError.html +1 -1
- data/doc/Files/InvalidInterfaceError.html +1 -1
- data/doc/Files/InvalidOauthError.html +1 -1
- data/doc/Files/InvalidOauthProviderError.html +1 -1
- data/doc/Files/InvalidOrExpiredCodeError.html +1 -1
- data/doc/Files/InvalidParameterError.html +5 -1
- data/doc/Files/InvalidPathError.html +1 -1
- data/doc/Files/InvalidPriorityColorError.html +1 -1
- data/doc/Files/InvalidRangeError.html +1 -1
- data/doc/Files/InvalidReturnToUrlError.html +1 -1
- data/doc/Files/InvalidSearchQueryError.html +1 -1
- data/doc/Files/InvalidSessionError.html +1 -1
- data/doc/Files/InvalidSiteError.html +1 -1
- data/doc/Files/InvalidSortFieldError.html +1 -1
- data/doc/Files/InvalidSortFilterCombinationError.html +1 -1
- data/doc/Files/InvalidUploadOffsetError.html +1 -1
- data/doc/Files/InvalidUploadPartGapError.html +1 -1
- data/doc/Files/InvalidUploadPartSizeError.html +1 -1
- data/doc/Files/InvalidUsernameOrPasswordError.html +1 -1
- data/doc/Files/InvalidWorkspaceIdHeaderError.html +1 -1
- data/doc/Files/InvalidZipFileError.html +1 -1
- data/doc/Files/Invoice.html +1 -1
- data/doc/Files/InvoiceLineItem.html +1 -1
- data/doc/Files/IpAddress.html +1 -1
- data/doc/Files/KeyLifecycleRule.html +1 -1
- data/doc/Files/List.html +1 -1
- data/doc/Files/Lock.html +1 -1
- data/doc/Files/LockOperationBusyError.html +1 -1
- data/doc/Files/LockedOutError.html +1 -1
- data/doc/Files/LockoutRegionMismatchError.html +1 -1
- data/doc/Files/MetadataCategory.html +1 -1
- data/doc/Files/MetadataNotSupportedOnRemotesError.html +1 -1
- data/doc/Files/MethodNotAllowedError.html +1 -1
- data/doc/Files/MigrationInProgressError.html +1 -1
- data/doc/Files/MissingParameterError.html +1 -1
- data/doc/Files/ModelSaveErrorError.html +1 -1
- data/doc/Files/MoverAccessDeniedError.html +1 -1
- data/doc/Files/MoverPackageRequiredError.html +1 -1
- data/doc/Files/MultipleProcessingErrorsError.html +1 -1
- data/doc/Files/MultipleSortParamsNotAllowedError.html +1 -1
- data/doc/Files/MustAuthenticateWithApiKeyError.html +1 -1
- data/doc/Files/NeedAdminPermissionForInboxError.html +1 -1
- data/doc/Files/NestedNotFoundError.html +1 -1
- data/doc/Files/NoAccountForSiteError.html +1 -1
- data/doc/Files/NoValidInputParamsError.html +1 -1
- data/doc/Files/NonAdminsMustQueryByFolderOrPathError.html +1 -1
- data/doc/Files/NotAllowedToCreateBundleError.html +1 -1
- data/doc/Files/NotAuthenticatedError.html +1 -1
- data/doc/Files/NotAuthorizedError.html +1 -1
- data/doc/Files/NotEnqueuableSyncError.html +1 -1
- data/doc/Files/NotFoundError.html +1 -1
- data/doc/Files/NotImplementedError.html +1 -1
- data/doc/Files/Notification.html +1 -1
- data/doc/Files/OffsetUploadNotAllowedWithMalwareScanningError.html +1 -1
- data/doc/Files/OneTimePasswordIncorrectError.html +1 -1
- data/doc/Files/OutboundConnectionLog.html +1 -1
- data/doc/Files/PartNumberTooLargeError.html +1 -1
- data/doc/Files/Partner.html +1 -1
- data/doc/Files/PartnerChannel.html +1 -1
- data/doc/Files/PartnerChannelTemplate.html +1 -1
- data/doc/Files/PartnerConnection.html +1 -1
- data/doc/Files/PartnerSite.html +1 -1
- data/doc/Files/PartnerSiteRequest.html +1 -1
- data/doc/Files/PasswordChangeNotRequiredError.html +1 -1
- data/doc/Files/PasswordChangeRequiredError.html +1 -1
- data/doc/Files/PathCannotHaveTrailingWhitespaceError.html +1 -1
- data/doc/Files/PathTooLongError.html +1 -1
- data/doc/Files/PathUtil.html +1 -1
- data/doc/Files/Payment.html +1 -1
- data/doc/Files/PaymentLineItem.html +1 -1
- data/doc/Files/PaymentMethodErrorError.html +1 -1
- data/doc/Files/PendingWorkEvent.html +1 -1
- data/doc/Files/Permission.html +1 -1
- data/doc/Files/PlanNotFoundError.html +1 -1
- data/doc/Files/Preview.html +1 -1
- data/doc/Files/PreviewOnlyPermissionCannotDownloadError.html +1 -1
- data/doc/Files/ProcessingFailureError.html +1 -1
- data/doc/Files/PublicHostingRequestLog.html +1 -1
- data/doc/Files/PublicIpAddress.html +1 -1
- data/doc/Files/PublicKey.html +1 -1
- data/doc/Files/RateLimitedError.html +1 -1
- data/doc/Files/ReadOnlySessionError.html +1 -1
- data/doc/Files/ReadPermissionRequiredError.html +1 -1
- data/doc/Files/ReauthenticationFailedError.html +1 -1
- data/doc/Files/ReauthenticationFailedFinalError.html +1 -1
- data/doc/Files/ReauthenticationNeededActionError.html +1 -1
- data/doc/Files/ReauthenticationNeededFieldsError.html +1 -1
- data/doc/Files/ReauthenticationRateLimitedError.html +1 -1
- data/doc/Files/RecaptchaFailedError.html +1 -1
- data/doc/Files/RecipientAlreadySharedError.html +1 -1
- data/doc/Files/RemoteBandwidthSnapshot.html +1 -1
- data/doc/Files/RemoteDesktopDebugLoggingDisabledError.html +1 -1
- data/doc/Files/RemoteEntryReadOnlyError.html +1 -1
- data/doc/Files/RemoteMountBackend.html +1 -1
- data/doc/Files/RemoteServer.html +1 -1
- data/doc/Files/RemoteServerConfigurationFile.html +1 -1
- data/doc/Files/RemoteServerCredential.html +1 -1
- data/doc/Files/RemoteServerErrorError.html +1 -1
- data/doc/Files/Request.html +1 -1
- data/doc/Files/RequestBodyTooLargeError.html +1 -1
- data/doc/Files/RequestParamsContainInvalidCharacterError.html +1 -1
- data/doc/Files/RequestParamsInvalidError.html +1 -1
- data/doc/Files/RequestParamsRequiredError.html +1 -1
- data/doc/Files/ResourceBelongsToParentSiteError.html +1 -1
- data/doc/Files/ResourceLockedError.html +1 -1
- data/doc/Files/Response.html +1 -1
- data/doc/Files/Restore.html +1 -1
- data/doc/Files/RootFolderBehaviorSiteAdminRequiredError.html +1 -1
- data/doc/Files/RootFolderBehaviorSkipSiteAdminRequiredError.html +1 -1
- data/doc/Files/Schedule.html +1 -1
- data/doc/Files/ScheduledExport.html +1 -1
- data/doc/Files/ScimLog.html +1 -1
- data/doc/Files/SearchAllOnChildPathError.html +1 -1
- data/doc/Files/SearchUnavailableError.html +1 -1
- data/doc/Files/Secret.html +1 -1
- data/doc/Files/SelfManagedRequiredError.html +1 -1
- data/doc/Files/ServiceUnavailableError.html +1 -1
- data/doc/Files/Session.html +1 -1
- data/doc/Files/SettingsChange.html +1 -1
- data/doc/Files/SftpActionLog.html +1 -1
- data/doc/Files/SftpHostKey.html +1 -1
- data/doc/Files/ShareGroup.html +1 -1
- data/doc/Files/ShareGroupMember.html +1 -1
- data/doc/Files/SiemHttpDestination.html +1 -1
- data/doc/Files/SiemHttpDestinationEvent.html +1 -1
- data/doc/Files/Site.html +1 -1
- data/doc/Files/SiteAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminRequiredError.html +1 -1
- data/doc/Files/SiteConfigurationError.html +1 -1
- data/doc/Files/SiteDisabledError.html +1 -1
- data/doc/Files/SiteFilesAreImmutableError.html +1 -1
- data/doc/Files/SiteNotFoundError.html +1 -1
- data/doc/Files/SiteSubdomainRedirect.html +1 -1
- data/doc/Files/SiteWasRemovedError.html +1 -1
- data/doc/Files/SizableIO.html +1 -1
- data/doc/Files/Snapshot.html +1 -1
- data/doc/Files/SsoEvent.html +1 -1
- data/doc/Files/SsoStrategy.html +1 -1
- data/doc/Files/Status.html +1 -1
- data/doc/Files/Style.html +1 -1
- data/doc/Files/SubfolderLockedError.html +1 -1
- data/doc/Files/Sync.html +1 -1
- data/doc/Files/SyncInProgressError.html +1 -1
- data/doc/Files/SyncLog.html +1 -1
- data/doc/Files/SyncRun.html +1 -1
- data/doc/Files/SyncRunLiveTransfer.html +1 -1
- data/doc/Files/SystemProfiler.html +1 -1
- data/doc/Files/TooManyConcurrentLoginsError.html +1 -1
- data/doc/Files/TooManyConcurrentRequestsError.html +1 -1
- data/doc/Files/TooManyLoginAttemptsError.html +1 -1
- data/doc/Files/TooManyRequestsError.html +1 -1
- data/doc/Files/TooManySharesError.html +1 -1
- data/doc/Files/Transfer/BufferLimitError.html +175 -0
- data/doc/Files/Transfer/ByteBudget/Reservation.html +301 -0
- data/doc/Files/Transfer/ByteBudget.html +748 -0
- data/doc/Files/Transfer/CancelledError.html +235 -0
- data/doc/Files/Transfer/Checkpoint.html +1371 -0
- data/doc/Files/Transfer/CheckpointError.html +173 -0
- data/doc/Files/Transfer/ClientTransport/ClientResponse.html +661 -0
- data/doc/Files/Transfer/ClientTransport/Reader.html +530 -0
- data/doc/Files/Transfer/ClientTransport.html +675 -0
- data/doc/Files/Transfer/Clock.html +189 -0
- data/doc/Files/Transfer/Control.html +667 -0
- data/doc/Files/Transfer/Controller/Attempt.html +465 -0
- data/doc/Files/Transfer/Controller.html +1166 -0
- data/doc/Files/Transfer/Coordinator/Timing.html +568 -0
- data/doc/Files/Transfer/Coordinator.html +534 -0
- data/doc/Files/Transfer/DownloadCoordinator/FileSink.html +976 -0
- data/doc/Files/Transfer/DownloadCoordinator/IoSink.html +1168 -0
- data/doc/Files/Transfer/DownloadCoordinator/Piece.html +875 -0
- data/doc/Files/Transfer/DownloadCoordinator.html +728 -0
- data/doc/Files/Transfer/FileSlots.html +480 -0
- data/doc/Files/Transfer/FrontendResponseError.html +235 -0
- data/doc/Files/Transfer/Holds.html +505 -0
- data/doc/Files/Transfer/HttpTransport.html +579 -0
- data/doc/Files/Transfer/Job.html +2338 -0
- data/doc/Files/Transfer/Options.html +924 -0
- data/doc/Files/Transfer/PausedError.html +319 -0
- data/doc/Files/Transfer/Policy.html +1642 -0
- data/doc/Files/Transfer/RequestPermits.html +160 -0
- data/doc/Files/Transfer/SourceChangedError.html +235 -0
- data/doc/Files/Transfer/StorageResponse.html +546 -0
- data/doc/Files/Transfer/StorageRetry.html +1098 -0
- data/doc/Files/Transfer/UploadCoordinator/Grant.html +1048 -0
- data/doc/Files/Transfer/UploadCoordinator/Part.html +1048 -0
- data/doc/Files/Transfer/UploadCoordinator/Region.html +295 -0
- data/doc/Files/Transfer/UploadCoordinator/Segments.html +299 -0
- data/doc/Files/Transfer/UploadCoordinator/Source.html +725 -0
- data/doc/Files/Transfer/UploadCoordinator/StreamSource.html +664 -0
- data/doc/Files/Transfer/UploadCoordinator.html +546 -0
- data/doc/Files/Transfer/UploadPlan.html +522 -0
- data/doc/Files/Transfer/VersionChangedError.html +235 -0
- data/doc/Files/Transfer.html +134 -0
- data/doc/Files/TrialExpiredError.html +1 -1
- data/doc/Files/TrialLockedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCodeAlreadySentError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCountryBlacklistedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationGeneralErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationMethodUnsupportedErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationRequiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationSetupExpiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationUnsubscribedRecipientError.html +1 -1
- data/doc/Files/URI.html +1 -1
- data/doc/Files/UnrecognizedSortIndexError.html +1 -1
- data/doc/Files/UnsupportedCurrencyError.html +1 -1
- data/doc/Files/UnsupportedHttpResponseFormatError.html +1 -1
- data/doc/Files/UnsupportedMediaTypeError.html +1 -1
- data/doc/Files/UpdatesNotAllowedForRemotesError.html +1 -1
- data/doc/Files/UploadsUnavailableError.html +1 -1
- data/doc/Files/UsageByTopLevelDir.html +1 -1
- data/doc/Files/UsageDailySnapshot.html +1 -1
- data/doc/Files/UsageSnapshot.html +1 -1
- data/doc/Files/User.html +1 -1
- data/doc/Files/UserAdditionalEmailRecipient.html +1 -1
- data/doc/Files/UserCipherUse.html +1 -1
- data/doc/Files/UserIdInvalidError.html +1 -1
- data/doc/Files/UserIdOnUserEndpointError.html +1 -1
- data/doc/Files/UserIdWithoutSiteAdminError.html +1 -1
- data/doc/Files/UserLifecycleRule.html +1 -1
- data/doc/Files/UserNotFoundError.html +1 -1
- data/doc/Files/UserRequest.html +1 -1
- data/doc/Files/UserRequestsEnabledRequiredError.html +1 -1
- data/doc/Files/UserRequiredError.html +1 -1
- data/doc/Files/UserSecurityEvent.html +1 -1
- data/doc/Files/UserSftpClientUse.html +1 -1
- data/doc/Files/Util/LogSettings.html +1 -1
- data/doc/Files/Util.html +1 -1
- data/doc/Files/WebDavActionLog.html +1 -1
- data/doc/Files/WebhookTest.html +1 -1
- data/doc/Files/Workspace.html +1 -1
- data/doc/Files/WriteAndBundlePermissionRequiredError.html +1 -1
- data/doc/Files/WritePermissionRequiredError.html +1 -1
- data/doc/Files/ZipListEntry.html +1 -1
- data/doc/Files.html +116 -116
- data/doc/_index.html +314 -4
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +4703 -2415
- data/doc/top-level-namespace.html +1 -1
- data/docs/file.md +346 -0
- data/lib/files.com/api.rb +6 -1
- data/lib/files.com/api_client.rb +220 -32
- data/lib/files.com/models/file.rb +124 -17
- data/lib/files.com/transfer/budgets.rb +123 -0
- data/lib/files.com/transfer/checkpoint.rb +113 -0
- data/lib/files.com/transfer/clock.rb +14 -0
- data/lib/files.com/transfer/controller.rb +549 -0
- data/lib/files.com/transfer/download_coordinator.rb +906 -0
- data/lib/files.com/transfer/errors.rb +100 -0
- data/lib/files.com/transfer/http_transport.rb +337 -0
- data/lib/files.com/transfer/job.rb +778 -0
- data/lib/files.com/transfer/options.rb +126 -0
- data/lib/files.com/transfer/policy.rb +91 -0
- data/lib/files.com/transfer/storage_retry.rb +169 -0
- data/lib/files.com/transfer/upload_coordinator.rb +657 -0
- data/lib/files.com/transfer/upload_plan.rb +157 -0
- data/lib/files.com.rb +13 -0
- data/spec/lib/api_client_spec.rb +125 -3
- data/spec/models/file_transfer_spec.rb +53 -4
- data/spec/support/transfer_server.rb +113 -14
- data/spec/transfer/adaptive_download_spec.rb +1102 -0
- data/spec/transfer/adaptive_upload_spec.rb +1602 -0
- data/spec/transfer/concurrency_controller_spec.rb +382 -0
- data/spec/workspace_id_spec.rb +19 -14
- metadata +59 -1
|
@@ -0,0 +1,1168 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Files::Transfer::DownloadCoordinator::IoSink
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.45
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css">
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css">
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Files::Transfer::DownloadCoordinator::IoSink";
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div id="main_progress" aria-hidden="true"></div>
|
|
31
|
+
|
|
32
|
+
<div class="nav_wrap">
|
|
33
|
+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
|
|
34
|
+
<div id="resizer"></div>
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
<div id="main" tabindex="-1">
|
|
38
|
+
<div id="header">
|
|
39
|
+
<div id="menu">
|
|
40
|
+
|
|
41
|
+
<a href="../../../_index.html">Index (I)</a> »
|
|
42
|
+
<span class='title'><span class='object_link'><a href="../../../Files.html" title="Files (module)">Files</a></span></span> » <span class='title'><span class='object_link'><a href="../../Transfer.html" title="Files::Transfer (module)">Transfer</a></span></span> » <span class='title'><span class='object_link'><a href="../DownloadCoordinator.html" title="Files::Transfer::DownloadCoordinator (class)">DownloadCoordinator</a></span></span>
|
|
43
|
+
»
|
|
44
|
+
<span class="title">IoSink</span>
|
|
45
|
+
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<div id="search">
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="class_list_link"
|
|
51
|
+
href="../../../class_list.html">
|
|
52
|
+
|
|
53
|
+
<svg width="24" height="24">
|
|
54
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
56
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
57
|
+
</svg>
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Files::Transfer::DownloadCoordinator::IoSink
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Files::Transfer::DownloadCoordinator::IoSink</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/files.com/transfer/download_coordinator.rb
|
|
100
|
+
</dd>
|
|
101
|
+
</dl>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
<h2>Overview</h2><div class="docstring">
|
|
106
|
+
<div class="discussion">
|
|
107
|
+
<p>The caller's IO, which stays open. It can start over only when it reports its position and can seek back and
|
|
108
|
+
truncate there, which it does as the next bytes are written, or as the download completes.</p>
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
120
|
+
<ul class="summary">
|
|
121
|
+
|
|
122
|
+
<li class="public ">
|
|
123
|
+
<span class="summary_signature">
|
|
124
|
+
|
|
125
|
+
<a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong> ⇒ Object </a>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</span>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<span class="note title readonly">readonly</span>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute start.</p></div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
</ul>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<h2>
|
|
156
|
+
Instance Method Summary
|
|
157
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
158
|
+
</h2>
|
|
159
|
+
|
|
160
|
+
<ul class="summary">
|
|
161
|
+
|
|
162
|
+
<li class="public ">
|
|
163
|
+
<span class="summary_signature">
|
|
164
|
+
|
|
165
|
+
<a href="#close-instance_method" title="#close (instance method)">#<strong>close</strong> ⇒ Object </a>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</span>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
180
|
+
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<li class="public ">
|
|
185
|
+
<span class="summary_signature">
|
|
186
|
+
|
|
187
|
+
<a href="#close_after_failure-instance_method" title="#close_after_failure (instance method)">#<strong>close_after_failure</strong>(error) ⇒ Object </a>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class="summary_desc"><div class='inline'><p>Pipe readers learn why the download failed before the pipe closes, and a failure to close never replaces the download's own error.</p></div></span>
|
|
202
|
+
|
|
203
|
+
</li>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<li class="public ">
|
|
207
|
+
<span class="summary_signature">
|
|
208
|
+
|
|
209
|
+
<a href="#holds%3F-instance_method" title="#holds? (instance method)">#<strong>holds?</strong>(bytes) ⇒ Boolean </a>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</span>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
224
|
+
|
|
225
|
+
</li>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<li class="public ">
|
|
229
|
+
<span class="summary_signature">
|
|
230
|
+
|
|
231
|
+
<a href="#identity-instance_method" title="#identity (instance method)">#<strong>identity</strong> ⇒ Object </a>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
</span>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<span class="summary_desc"><div class='inline'><p>The IO object itself, never a number another object could reuse.</p></div></span>
|
|
246
|
+
|
|
247
|
+
</li>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<li class="public ">
|
|
251
|
+
<span class="summary_signature">
|
|
252
|
+
|
|
253
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(io, start: :current) ⇒ IoSink </a>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<span class="note title constructor">constructor</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of IoSink.</p></div></span>
|
|
270
|
+
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<li class="public ">
|
|
275
|
+
<span class="summary_signature">
|
|
276
|
+
|
|
277
|
+
<a href="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(io) ⇒ Boolean </a>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</span>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong> ⇒ Object </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
314
|
+
|
|
315
|
+
</li>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<li class="public ">
|
|
319
|
+
<span class="summary_signature">
|
|
320
|
+
|
|
321
|
+
<a href="#position-instance_method" title="#position (instance method)">#<strong>position</strong> ⇒ Object </a>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</span>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
336
|
+
|
|
337
|
+
</li>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
<li class="public ">
|
|
341
|
+
<span class="summary_signature">
|
|
342
|
+
|
|
343
|
+
<a href="#prefix_digest-instance_method" title="#prefix_digest (instance method)">#<strong>prefix_digest</strong>(bytes, chunk) ⇒ Object </a>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
</span>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<span class="summary_desc"><div class='inline'><p>A digest of the bytes written from start, read back chunk bytes at a time without moving where the IO writes next: from a StringIO's string, with pread, by seeking back and reading, or, for a File it cannot read, from its path while that is still the same file.</p></div></span>
|
|
358
|
+
|
|
359
|
+
</li>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<li class="public ">
|
|
363
|
+
<span class="summary_signature">
|
|
364
|
+
|
|
365
|
+
<a href="#restart!-instance_method" title="#restart! (instance method)">#<strong>restart!</strong> ⇒ Object </a>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
380
|
+
|
|
381
|
+
</li>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<li class="public ">
|
|
385
|
+
<span class="summary_signature">
|
|
386
|
+
|
|
387
|
+
<a href="#restartable%3F-instance_method" title="#restartable? (instance method)">#<strong>restartable?</strong> ⇒ Boolean </a>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
</span>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#resume_at!-instance_method" title="#resume_at! (instance method)">#<strong>resume_at!</strong>(_bytes) ⇒ Object </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
424
|
+
|
|
425
|
+
</li>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<li class="public ">
|
|
429
|
+
<span class="summary_signature">
|
|
430
|
+
|
|
431
|
+
<a href="#settle!-instance_method" title="#settle! (instance method)">#<strong>settle!</strong> ⇒ Object </a>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
</span>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
446
|
+
|
|
447
|
+
</li>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<li class="public ">
|
|
451
|
+
<span class="summary_signature">
|
|
452
|
+
|
|
453
|
+
<a href="#verifiable%3F-instance_method" title="#verifiable? (instance method)">#<strong>verifiable?</strong> ⇒ Boolean </a>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</span>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<span class="summary_desc"><div class='inline'><p>Whether a resume could check the bytes written: only when the IO said where they begin.</p></div></span>
|
|
468
|
+
|
|
469
|
+
</li>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
<li class="public ">
|
|
473
|
+
<span class="summary_signature">
|
|
474
|
+
|
|
475
|
+
<a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong>(data) ⇒ Object </a>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
</span>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
490
|
+
|
|
491
|
+
</li>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
</ul>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
<div id="constructor_details" class="method_details_list">
|
|
499
|
+
<h2>Constructor Details</h2>
|
|
500
|
+
|
|
501
|
+
<div class="method_details first">
|
|
502
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
503
|
+
|
|
504
|
+
#<strong>initialize</strong>(io, start: :current) ⇒ <tt><span class='object_link'><a href="" title="Files::Transfer::DownloadCoordinator::IoSink (class)">IoSink</a></span></tt>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
<p>Returns a new instance of IoSink.</p>
|
|
513
|
+
|
|
514
|
+
</div>
|
|
515
|
+
</div>
|
|
516
|
+
<div class="tags">
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
</div><table class="source_code">
|
|
520
|
+
<tr>
|
|
521
|
+
<td>
|
|
522
|
+
<pre class="lines">
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
142
|
|
526
|
+
143
|
|
527
|
+
144
|
|
528
|
+
145
|
|
529
|
+
146</pre>
|
|
530
|
+
</td>
|
|
531
|
+
<td>
|
|
532
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 142</span>
|
|
533
|
+
|
|
534
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='label'>start:</span> <span class='symbol'>:current</span><span class='rparen'>)</span>
|
|
535
|
+
<span class='ivar'>@io</span> <span class='op'>=</span> <span class='id identifier rubyid_io'>io</span>
|
|
536
|
+
<span class='ivar'>@start</span> <span class='op'>=</span> <span class='id identifier rubyid_start'>start</span> <span class='op'>==</span> <span class='symbol'>:current</span> <span class='op'>?</span> <span class='id identifier rubyid_position'>position</span> <span class='op'>:</span> <span class='id identifier rubyid_start'>start</span>
|
|
537
|
+
<span class='ivar'>@pending</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
538
|
+
<span class='kw'>end</span></pre>
|
|
539
|
+
</td>
|
|
540
|
+
</tr>
|
|
541
|
+
</table>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
<div id="instance_attr_details" class="attr_details">
|
|
547
|
+
<h2>Instance Attribute Details</h2>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<span id=""></span>
|
|
551
|
+
<div class="method_details first">
|
|
552
|
+
<h3 class="signature first" id="start-instance_method">
|
|
553
|
+
|
|
554
|
+
#<strong>start</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</h3><div class="docstring">
|
|
561
|
+
<div class="discussion">
|
|
562
|
+
<p>Returns the value of attribute start.</p>
|
|
563
|
+
|
|
564
|
+
</div>
|
|
565
|
+
</div>
|
|
566
|
+
<div class="tags">
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
</div><table class="source_code">
|
|
570
|
+
<tr>
|
|
571
|
+
<td>
|
|
572
|
+
<pre class="lines">
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
140
|
|
576
|
+
141
|
|
577
|
+
142</pre>
|
|
578
|
+
</td>
|
|
579
|
+
<td>
|
|
580
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 140</span>
|
|
581
|
+
|
|
582
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span>
|
|
583
|
+
<span class='ivar'>@start</span>
|
|
584
|
+
<span class='kw'>end</span></pre>
|
|
585
|
+
</td>
|
|
586
|
+
</tr>
|
|
587
|
+
</table>
|
|
588
|
+
</div>
|
|
589
|
+
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<div id="instance_method_details" class="method_details_list">
|
|
594
|
+
<h2>Instance Method Details</h2>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<div class="method_details first">
|
|
598
|
+
<h3 class="signature first" id="close-instance_method">
|
|
599
|
+
|
|
600
|
+
#<strong>close</strong> ⇒ <tt>Object</tt>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</h3><table class="source_code">
|
|
607
|
+
<tr>
|
|
608
|
+
<td>
|
|
609
|
+
<pre class="lines">
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
211</pre>
|
|
613
|
+
</td>
|
|
614
|
+
<td>
|
|
615
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 211</span>
|
|
616
|
+
|
|
617
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
618
|
+
</td>
|
|
619
|
+
</tr>
|
|
620
|
+
</table>
|
|
621
|
+
</div>
|
|
622
|
+
|
|
623
|
+
<div class="method_details ">
|
|
624
|
+
<h3 class="signature " id="close_after_failure-instance_method">
|
|
625
|
+
|
|
626
|
+
#<strong>close_after_failure</strong>(error) ⇒ <tt>Object</tt>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</h3><div class="docstring">
|
|
633
|
+
<div class="discussion">
|
|
634
|
+
<p>Pipe readers learn why the download failed before the pipe closes, and a failure to close never replaces the
|
|
635
|
+
download's own error.</p>
|
|
636
|
+
|
|
637
|
+
</div>
|
|
638
|
+
</div>
|
|
639
|
+
<div class="tags">
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
</div><table class="source_code">
|
|
643
|
+
<tr>
|
|
644
|
+
<td>
|
|
645
|
+
<pre class="lines">
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
274
|
|
649
|
+
275
|
|
650
|
+
276
|
|
651
|
+
277
|
|
652
|
+
278
|
|
653
|
+
279</pre>
|
|
654
|
+
</td>
|
|
655
|
+
<td>
|
|
656
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 274</span>
|
|
657
|
+
|
|
658
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_close_after_failure'>close_after_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
|
|
659
|
+
<span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_do_set_error'>do_set_error</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:do_set_error</span><span class='rparen'>)</span>
|
|
660
|
+
<span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
|
|
661
|
+
<span class='kw'>rescue</span> <span class='const'>StandardError</span>
|
|
662
|
+
<span class='kw'>nil</span>
|
|
663
|
+
<span class='kw'>end</span></pre>
|
|
664
|
+
</td>
|
|
665
|
+
</tr>
|
|
666
|
+
</table>
|
|
667
|
+
</div>
|
|
668
|
+
|
|
669
|
+
<div class="method_details ">
|
|
670
|
+
<h3 class="signature " id="holds?-instance_method">
|
|
671
|
+
|
|
672
|
+
#<strong>holds?</strong>(bytes) ⇒ <tt>Boolean</tt>
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</h3><div class="docstring">
|
|
679
|
+
<div class="discussion">
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
</div>
|
|
683
|
+
</div>
|
|
684
|
+
<div class="tags">
|
|
685
|
+
|
|
686
|
+
<p class="tag_title">Returns:</p>
|
|
687
|
+
<ul class="return">
|
|
688
|
+
|
|
689
|
+
<li>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
</li>
|
|
697
|
+
|
|
698
|
+
</ul>
|
|
699
|
+
|
|
700
|
+
</div><table class="source_code">
|
|
701
|
+
<tr>
|
|
702
|
+
<td>
|
|
703
|
+
<pre class="lines">
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
193
|
|
707
|
+
194
|
|
708
|
+
195</pre>
|
|
709
|
+
</td>
|
|
710
|
+
<td>
|
|
711
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 193</span>
|
|
712
|
+
|
|
713
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_holds?'>holds?</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</span><span class='rparen'>)</span>
|
|
714
|
+
<span class='op'>!</span><span class='ivar'>@start</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='id identifier rubyid_position'>position</span> <span class='op'>==</span> <span class='ivar'>@start</span> <span class='op'>+</span> <span class='id identifier rubyid_bytes'>bytes</span>
|
|
715
|
+
<span class='kw'>end</span></pre>
|
|
716
|
+
</td>
|
|
717
|
+
</tr>
|
|
718
|
+
</table>
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
<div class="method_details ">
|
|
722
|
+
<h3 class="signature " id="identity-instance_method">
|
|
723
|
+
|
|
724
|
+
#<strong>identity</strong> ⇒ <tt>Object</tt>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
</h3><div class="docstring">
|
|
731
|
+
<div class="discussion">
|
|
732
|
+
<p>The IO object itself, never a number another object could reuse.</p>
|
|
733
|
+
|
|
734
|
+
</div>
|
|
735
|
+
</div>
|
|
736
|
+
<div class="tags">
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
</div><table class="source_code">
|
|
740
|
+
<tr>
|
|
741
|
+
<td>
|
|
742
|
+
<pre class="lines">
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
185
|
|
746
|
+
186
|
|
747
|
+
187</pre>
|
|
748
|
+
</td>
|
|
749
|
+
<td>
|
|
750
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 185</span>
|
|
751
|
+
|
|
752
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_identity'>identity</span>
|
|
753
|
+
<span class='lbracket'>[</span> <span class='symbol'>:io</span><span class='comma'>,</span> <span class='ivar'>@io</span><span class='comma'>,</span> <span class='ivar'>@start</span> <span class='rbracket'>]</span>
|
|
754
|
+
<span class='kw'>end</span></pre>
|
|
755
|
+
</td>
|
|
756
|
+
</tr>
|
|
757
|
+
</table>
|
|
758
|
+
</div>
|
|
759
|
+
|
|
760
|
+
<div class="method_details ">
|
|
761
|
+
<h3 class="signature " id="matches?-instance_method">
|
|
762
|
+
|
|
763
|
+
#<strong>matches?</strong>(io) ⇒ <tt>Boolean</tt>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
</h3><div class="docstring">
|
|
770
|
+
<div class="discussion">
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
</div>
|
|
774
|
+
</div>
|
|
775
|
+
<div class="tags">
|
|
776
|
+
|
|
777
|
+
<p class="tag_title">Returns:</p>
|
|
778
|
+
<ul class="return">
|
|
779
|
+
|
|
780
|
+
<li>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</li>
|
|
788
|
+
|
|
789
|
+
</ul>
|
|
790
|
+
|
|
791
|
+
</div><table class="source_code">
|
|
792
|
+
<tr>
|
|
793
|
+
<td>
|
|
794
|
+
<pre class="lines">
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
189
|
|
798
|
+
190
|
|
799
|
+
191</pre>
|
|
800
|
+
</td>
|
|
801
|
+
<td>
|
|
802
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 189</span>
|
|
803
|
+
|
|
804
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='rparen'>)</span>
|
|
805
|
+
<span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_equal?'>equal?</span><span class='lparen'>(</span><span class='ivar'>@io</span><span class='rparen'>)</span>
|
|
806
|
+
<span class='kw'>end</span></pre>
|
|
807
|
+
</td>
|
|
808
|
+
</tr>
|
|
809
|
+
</table>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
<div class="method_details ">
|
|
813
|
+
<h3 class="signature " id="path-instance_method">
|
|
814
|
+
|
|
815
|
+
#<strong>path</strong> ⇒ <tt>Object</tt>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
</h3><table class="source_code">
|
|
822
|
+
<tr>
|
|
823
|
+
<td>
|
|
824
|
+
<pre class="lines">
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
148
|
|
828
|
+
149
|
|
829
|
+
150</pre>
|
|
830
|
+
</td>
|
|
831
|
+
<td>
|
|
832
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 148</span>
|
|
833
|
+
|
|
834
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
|
|
835
|
+
<span class='kw'>nil</span>
|
|
836
|
+
<span class='kw'>end</span></pre>
|
|
837
|
+
</td>
|
|
838
|
+
</tr>
|
|
839
|
+
</table>
|
|
840
|
+
</div>
|
|
841
|
+
|
|
842
|
+
<div class="method_details ">
|
|
843
|
+
<h3 class="signature " id="position-instance_method">
|
|
844
|
+
|
|
845
|
+
#<strong>position</strong> ⇒ <tt>Object</tt>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
</h3><table class="source_code">
|
|
852
|
+
<tr>
|
|
853
|
+
<td>
|
|
854
|
+
<pre class="lines">
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
157
|
|
858
|
+
158
|
|
859
|
+
159
|
|
860
|
+
160
|
|
861
|
+
161</pre>
|
|
862
|
+
</td>
|
|
863
|
+
<td>
|
|
864
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 157</span>
|
|
865
|
+
|
|
866
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span>
|
|
867
|
+
<span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_pos'>pos</span> <span class='kw'>if</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:pos</span><span class='rparen'>)</span>
|
|
868
|
+
<span class='kw'>rescue</span> <span class='const'>IOError</span><span class='comma'>,</span> <span class='const'>SystemCallError</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../NotImplementedError.html" title="Files::NotImplementedError (class)">NotImplementedError</a></span></span>
|
|
869
|
+
<span class='kw'>nil</span>
|
|
870
|
+
<span class='kw'>end</span></pre>
|
|
871
|
+
</td>
|
|
872
|
+
</tr>
|
|
873
|
+
</table>
|
|
874
|
+
</div>
|
|
875
|
+
|
|
876
|
+
<div class="method_details ">
|
|
877
|
+
<h3 class="signature " id="prefix_digest-instance_method">
|
|
878
|
+
|
|
879
|
+
#<strong>prefix_digest</strong>(bytes, chunk) ⇒ <tt>Object</tt>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
</h3><div class="docstring">
|
|
886
|
+
<div class="discussion">
|
|
887
|
+
<p>A digest of the bytes written from start, read back chunk bytes at a time without moving where the IO writes
|
|
888
|
+
next: from a StringIO's string, with pread, by seeking back and reading, or, for a File it cannot read, from its
|
|
889
|
+
path while that is still the same file. A Tempfile and other delegators read back as what they delegate to.
|
|
890
|
+
false when it holds fewer bytes; nil when it cannot give them back at all.</p>
|
|
891
|
+
|
|
892
|
+
</div>
|
|
893
|
+
</div>
|
|
894
|
+
<div class="tags">
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
</div><table class="source_code">
|
|
898
|
+
<tr>
|
|
899
|
+
<td>
|
|
900
|
+
<pre class="lines">
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
201
|
|
904
|
+
202
|
|
905
|
+
203
|
|
906
|
+
204
|
|
907
|
+
205
|
|
908
|
+
206
|
|
909
|
+
207</pre>
|
|
910
|
+
</td>
|
|
911
|
+
<td>
|
|
912
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 201</span>
|
|
913
|
+
|
|
914
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_prefix_digest'>prefix_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</span><span class='comma'>,</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='rparen'>)</span>
|
|
915
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='ivar'>@start</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
916
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_string_digest'>string_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</span><span class='comma'>,</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>StringIO</span><span class='rparen'>)</span>
|
|
917
|
+
|
|
918
|
+
<span class='id identifier rubyid_digest'>digest</span> <span class='op'>=</span> <span class='id identifier rubyid_read_back_digest'>read_back_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</span><span class='comma'>,</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='rparen'>)</span>
|
|
919
|
+
<span class='id identifier rubyid_digest'>digest</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_path_digest'>path_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</span><span class='comma'>,</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_digest'>digest</span>
|
|
920
|
+
<span class='kw'>end</span></pre>
|
|
921
|
+
</td>
|
|
922
|
+
</tr>
|
|
923
|
+
</table>
|
|
924
|
+
</div>
|
|
925
|
+
|
|
926
|
+
<div class="method_details ">
|
|
927
|
+
<h3 class="signature " id="restart!-instance_method">
|
|
928
|
+
|
|
929
|
+
#<strong>restart!</strong> ⇒ <tt>Object</tt>
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
</h3><table class="source_code">
|
|
936
|
+
<tr>
|
|
937
|
+
<td>
|
|
938
|
+
<pre class="lines">
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
167
|
|
942
|
+
168
|
|
943
|
+
169</pre>
|
|
944
|
+
</td>
|
|
945
|
+
<td>
|
|
946
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 167</span>
|
|
947
|
+
|
|
948
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_restart!'>restart!</span>
|
|
949
|
+
<span class='ivar'>@pending</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
950
|
+
<span class='kw'>end</span></pre>
|
|
951
|
+
</td>
|
|
952
|
+
</tr>
|
|
953
|
+
</table>
|
|
954
|
+
</div>
|
|
955
|
+
|
|
956
|
+
<div class="method_details ">
|
|
957
|
+
<h3 class="signature " id="restartable?-instance_method">
|
|
958
|
+
|
|
959
|
+
#<strong>restartable?</strong> ⇒ <tt>Boolean</tt>
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
</h3><div class="docstring">
|
|
966
|
+
<div class="discussion">
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
</div>
|
|
970
|
+
</div>
|
|
971
|
+
<div class="tags">
|
|
972
|
+
|
|
973
|
+
<p class="tag_title">Returns:</p>
|
|
974
|
+
<ul class="return">
|
|
975
|
+
|
|
976
|
+
<li>
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
</li>
|
|
984
|
+
|
|
985
|
+
</ul>
|
|
986
|
+
|
|
987
|
+
</div><table class="source_code">
|
|
988
|
+
<tr>
|
|
989
|
+
<td>
|
|
990
|
+
<pre class="lines">
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
163
|
|
994
|
+
164
|
|
995
|
+
165</pre>
|
|
996
|
+
</td>
|
|
997
|
+
<td>
|
|
998
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 163</span>
|
|
999
|
+
|
|
1000
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_restartable?'>restartable?</span>
|
|
1001
|
+
<span class='op'>!</span><span class='ivar'>@start</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:seek</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:truncate</span><span class='rparen'>)</span>
|
|
1002
|
+
<span class='kw'>end</span></pre>
|
|
1003
|
+
</td>
|
|
1004
|
+
</tr>
|
|
1005
|
+
</table>
|
|
1006
|
+
</div>
|
|
1007
|
+
|
|
1008
|
+
<div class="method_details ">
|
|
1009
|
+
<h3 class="signature " id="resume_at!-instance_method">
|
|
1010
|
+
|
|
1011
|
+
#<strong>resume_at!</strong>(_bytes) ⇒ <tt>Object</tt>
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
</h3><table class="source_code">
|
|
1018
|
+
<tr>
|
|
1019
|
+
<td>
|
|
1020
|
+
<pre class="lines">
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
209</pre>
|
|
1024
|
+
</td>
|
|
1025
|
+
<td>
|
|
1026
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 209</span>
|
|
1027
|
+
|
|
1028
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resume_at!'>resume_at!</span><span class='lparen'>(</span><span class='id identifier rubyid__bytes'>_bytes</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1029
|
+
</td>
|
|
1030
|
+
</tr>
|
|
1031
|
+
</table>
|
|
1032
|
+
</div>
|
|
1033
|
+
|
|
1034
|
+
<div class="method_details ">
|
|
1035
|
+
<h3 class="signature " id="settle!-instance_method">
|
|
1036
|
+
|
|
1037
|
+
#<strong>settle!</strong> ⇒ <tt>Object</tt>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
</h3><table class="source_code">
|
|
1044
|
+
<tr>
|
|
1045
|
+
<td>
|
|
1046
|
+
<pre class="lines">
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
171
|
|
1050
|
+
172
|
|
1051
|
+
173
|
|
1052
|
+
174
|
|
1053
|
+
175
|
|
1054
|
+
176
|
|
1055
|
+
177</pre>
|
|
1056
|
+
</td>
|
|
1057
|
+
<td>
|
|
1058
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 171</span>
|
|
1059
|
+
|
|
1060
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_settle!'>settle!</span>
|
|
1061
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@pending</span>
|
|
1062
|
+
|
|
1063
|
+
<span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_seek'>seek</span><span class='lparen'>(</span><span class='ivar'>@start</span><span class='rparen'>)</span>
|
|
1064
|
+
<span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_truncate'>truncate</span><span class='lparen'>(</span><span class='ivar'>@start</span><span class='rparen'>)</span>
|
|
1065
|
+
<span class='ivar'>@pending</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
1066
|
+
<span class='kw'>end</span></pre>
|
|
1067
|
+
</td>
|
|
1068
|
+
</tr>
|
|
1069
|
+
</table>
|
|
1070
|
+
</div>
|
|
1071
|
+
|
|
1072
|
+
<div class="method_details ">
|
|
1073
|
+
<h3 class="signature " id="verifiable?-instance_method">
|
|
1074
|
+
|
|
1075
|
+
#<strong>verifiable?</strong> ⇒ <tt>Boolean</tt>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
</h3><div class="docstring">
|
|
1082
|
+
<div class="discussion">
|
|
1083
|
+
<p>Whether a resume could check the bytes written: only when the IO said where they begin.</p>
|
|
1084
|
+
|
|
1085
|
+
</div>
|
|
1086
|
+
</div>
|
|
1087
|
+
<div class="tags">
|
|
1088
|
+
|
|
1089
|
+
<p class="tag_title">Returns:</p>
|
|
1090
|
+
<ul class="return">
|
|
1091
|
+
|
|
1092
|
+
<li>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
</li>
|
|
1100
|
+
|
|
1101
|
+
</ul>
|
|
1102
|
+
|
|
1103
|
+
</div><table class="source_code">
|
|
1104
|
+
<tr>
|
|
1105
|
+
<td>
|
|
1106
|
+
<pre class="lines">
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
180
|
|
1110
|
+
181
|
|
1111
|
+
182</pre>
|
|
1112
|
+
</td>
|
|
1113
|
+
<td>
|
|
1114
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 180</span>
|
|
1115
|
+
|
|
1116
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_verifiable?'>verifiable?</span>
|
|
1117
|
+
<span class='op'>!</span><span class='ivar'>@start</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1118
|
+
<span class='kw'>end</span></pre>
|
|
1119
|
+
</td>
|
|
1120
|
+
</tr>
|
|
1121
|
+
</table>
|
|
1122
|
+
</div>
|
|
1123
|
+
|
|
1124
|
+
<div class="method_details ">
|
|
1125
|
+
<h3 class="signature " id="write-instance_method">
|
|
1126
|
+
|
|
1127
|
+
#<strong>write</strong>(data) ⇒ <tt>Object</tt>
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
</h3><table class="source_code">
|
|
1134
|
+
<tr>
|
|
1135
|
+
<td>
|
|
1136
|
+
<pre class="lines">
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
152
|
|
1140
|
+
153
|
|
1141
|
+
154
|
|
1142
|
+
155</pre>
|
|
1143
|
+
</td>
|
|
1144
|
+
<td>
|
|
1145
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/download_coordinator.rb', line 152</span>
|
|
1146
|
+
|
|
1147
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1148
|
+
<span class='id identifier rubyid_settle!'>settle!</span>
|
|
1149
|
+
<span class='ivar'>@io</span> <span class='op'><<</span> <span class='id identifier rubyid_data'>data</span>
|
|
1150
|
+
<span class='kw'>end</span></pre>
|
|
1151
|
+
</td>
|
|
1152
|
+
</tr>
|
|
1153
|
+
</table>
|
|
1154
|
+
</div>
|
|
1155
|
+
|
|
1156
|
+
</div>
|
|
1157
|
+
|
|
1158
|
+
</div>
|
|
1159
|
+
|
|
1160
|
+
<div id="footer">
|
|
1161
|
+
Generated on Tue Nov 3 18:04:22 2026 by
|
|
1162
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1163
|
+
0.9.45 (ruby-4.0.9).
|
|
1164
|
+
</div>
|
|
1165
|
+
|
|
1166
|
+
</div>
|
|
1167
|
+
</body>
|
|
1168
|
+
</html>
|