Skip to content

Truncate existing file in CreateText #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2025
Merged

Truncate existing file in CreateText #1686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 18 additions & 48 deletions src/Renci.SshNet/ISftpClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,12 +454,8 @@ public interface ISftpClient : IBaseClient
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
/// <remarks>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// </para>
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </remarks>
StreamWriter CreateText(string path);

Expand All @@ -476,12 +472,8 @@ public interface ISftpClient : IBaseClient
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
/// <remarks>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// </para>
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </remarks>
StreamWriter CreateText(string path, Encoding encoding);

Expand Down Expand Up @@ -1151,12 +1143,8 @@ public interface ISftpClient : IBaseClient
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
/// <remarks>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// </para>
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </remarks>
void WriteAllBytes(string path, byte[] bytes);

Expand All @@ -1174,10 +1162,8 @@ public interface ISftpClient : IBaseClient
/// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
/// </para>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </para>
/// </remarks>
void WriteAllLines(string path, IEnumerable<string> contents);
Expand All @@ -1193,12 +1179,8 @@ public interface ISftpClient : IBaseClient
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
/// <remarks>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// </para>
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </remarks>
void WriteAllLines(string path, IEnumerable<string> contents, Encoding encoding);

Expand All @@ -1216,10 +1198,8 @@ public interface ISftpClient : IBaseClient
/// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
/// </para>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </para>
/// </remarks>
void WriteAllLines(string path, string[] contents);
Expand All @@ -1235,12 +1215,8 @@ public interface ISftpClient : IBaseClient
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
/// <remarks>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// </para>
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </remarks>
void WriteAllLines(string path, string[] contents, Encoding encoding);

Expand All @@ -1258,10 +1234,8 @@ public interface ISftpClient : IBaseClient
/// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
/// </para>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </para>
/// </remarks>
void WriteAllText(string path, string contents);
Expand All @@ -1277,12 +1251,8 @@ public interface ISftpClient : IBaseClient
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
/// <remarks>
/// <para>
/// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
/// </para>
/// <para>
/// If the target file does not exist, it is created.
/// </para>
/// If the file specified by <paramref name="path"/> does not exist, it is created.
/// If the file does exist, its contents are replaced.
/// </remarks>
void WriteAllText(string path, string contents, Encoding encoding);
}
Expand Down
Loading