Add a CloseAction that will be executed each time the resource is closed.
Add a CloseAction that will be executed each time the resource is closed.
the action to add
a new resource instance with the close action added
Get the Resource context associated with this Resource instance.
Get the Resource context associated with this Resource instance.
the associated ResourceContext
as Resources are immutable objects a given Resource instance will always be associated with the same ResourceContext
Creates a new instance of the underlying resource (or opens it).
Creates a new instance of the underlying resource (or opens it). Sometimes the code block used to create the Resource is non-reusable in which case this Resource can only be used once. This is not recommended.
When creating a resource it is recommended to pass the code block for creating the resource to the resource so that the resource can be reused. Of course this is not always possible
This method should only be used with care in cases when Automatic
Resource Management cannot be used because the
InputStream
must be closed manually.
This is public only to permit interoperability with certain Java APIs. A better pattern of use should be:
resource.acquireFor {
// call java API
}
or
val calculatedResult = resource.acquireAndGet { // cal java API that returns a result }
the actual resource that has been opened
normally the error handler registered with the associated ResourceContext will handle any errors opening the resource, but when calling this method the caller must handle any possible errors that are raised.
Create a Resource instance that is configured with the new ResourceContext
Create a Resource instance that is configured with the new ResourceContext
A new ResourceContext
a new instance configured with the new context
Open the resource execute the function and either return all errors as a list or the result of the function execution.
Open the resource execute the function and either return all errors as a list or the result of the function execution.
On open and close error handlers in ResourceContext are called. If they then raise errors the errors are captured and returned as a Right[List[Throwable]]
Perhaps the worst method I have ever written :-(
Update the current ResourceContext and return a new Resource instance with the updated context
Update the current ResourceContext and return a new Resource instance with the updated context
A function for transforming the current context to a new context with new values.
a new instance configured with the new context
A Resource that can be used to do IO. Primarily it wraps objects from the java io and makes them more Scala friendly.
A common question about Resource is: "Why no simply expose scalax.io.Input, scalax.io.Output, scalax.io.Seekable, scalax.io.ReadChars, scalax.io.WriteChars? Why do we need a Resource[R] object?"
There are several reasons for this. There are several situations where a developer needs access to the underlying resource.
Perhaps they need to interact with a Java API which does not use the scalax.io.Input, etc... APIs. Another possibility is that the resource may be a specific implementation like PrintStream and they want to use those custom APIs instead of the Scala IO apis. In that case Resource provides them with the ARM functionality that is very useful.
The type of the resource that will be managed by the ManagedResource
1.0