79 lines
1.5 KiB
Plaintext
79 lines
1.5 KiB
Plaintext
It is possible in an ``++IDisposable++`` to call ``++Dispose++`` on class members from any method, but the contract of ``++Dispose++`` is that it will clean up all unmanaged resources. Move disposing of members to some other method, and you risk resource leaks.
|
|
|
|
|
|
This rule also applies for disposable ref structs.
|
|
|
|
|
|
== Noncompliant Code Example
|
|
|
|
[source,csharp]
|
|
----
|
|
public class ResourceHolder : IDisposable
|
|
{
|
|
private FileStream fs;
|
|
public void OpenResource(string path)
|
|
{
|
|
this.fs = new FileStream(path, FileMode.Open);
|
|
}
|
|
public void CloseResource()
|
|
{
|
|
this.fs.Close();
|
|
}
|
|
|
|
public void CleanUp()
|
|
{
|
|
this.fs.Dispose(); // Noncompliant; Dispose not called in class' Dispose method
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
// method added to satisfy demands of interface
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
== Compliant Solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public class ResourceHolder : IDisposable
|
|
{
|
|
private FileStream fs;
|
|
public void OpenResource(string path)
|
|
{
|
|
this.fs = new FileStream(path, FileMode.Open);
|
|
}
|
|
public void CloseResource()
|
|
{
|
|
this.fs.Close();
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
this.fs.Dispose();
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
== See
|
|
|
|
* https://cwe.mitre.org/data/definitions/459[MITRE, CWE-459] - Incomplete Cleanup
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::comments-and-links.adoc[]
|
|
endif::env-github,rspecator-view[]
|